Skip to content

Commit 83ab59e

Browse files
committed
docs: add tugboat documentation
1 parent e4da3d0 commit 83ab59e

6 files changed

+56
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
import { Meta } from '@storybook/addon-docs';
2+
import registerTugboat from './img/register-tugboat.png';
3+
import createPreviews from './img/create-previews.png';
4+
import developmentSettings from './img/development-settings.png';
5+
import mainSettings from './img/main-settings.png';
6+
7+
<Meta title="Documentation/Configure Tugboat" />
8+
9+
# Configure Tugboat
10+
11+
Tugboat is a preview environment generator supported in this project. If you
12+
don't want or need Tugboat integration, please delete the `.tugboat` directory
13+
in the codebase and forget about it.
14+
15+
## Supported features
16+
17+
This project comes with Tugboat preconfigured to generate the following
18+
environments on each pull request:
19+
20+
- The **Storybook** widget catalog to preview the changes being proposed.
21+
- A **vanilla Drupal** site pre-configured with a page to show how the widget
22+
proposed in the PR will work in a Drupal environment.
23+
24+
## Register the repository in Tugboat
25+
26+
Once you have registered and decided which plan to use (you can start with the
27+
free plan and upgrade later if you feel the need of it), you will need to
28+
connect your repository with Tugboat.
29+
30+
Read [the Tugboat documentation](https://docs.tugboatqa.com/setting-up-tugboat/)
31+
to do so, but here is a TL;DR.
32+
33+
<img src={registerTugboat} alt="Create new project" />
34+
35+
After connecting your repo with Tugboat, you'll see the branches in your repo.
36+
We'll treat `development` as the default base branch. PRs will likely be made
37+
against this branch to introduce new features or bug fixes.
38+
39+
In order to leverage base previews in Tugboat (highly recommended) we'll need to
40+
create our base previews for the `development` and `main` branches.
41+
42+
<img src={createPreviews} alt="Create previews" />
43+
44+
The preview generated from `development` will be our base preview for the
45+
project.
46+
47+
<img src={developmentSettings} alt="Development settings" />
48+
49+
The `main` branch will be our baseline of what is in production, so any PR
50+
created against `main` will use this preview as a base. Learn more about preview
51+
environments and base previews in the official documentation.
52+
53+
<img src={mainSettings} alt="Main settings" />
54+
55+
Once this is configured, when a developer creates a new Pull Request, a new
56+
environment will be created for that PR in Tugboat.
171 KB
Loading
153 KB
Loading
124 KB
Loading

.storybook/docs/img/main-settings.png

118 KB
Loading
190 KB
Loading

0 commit comments

Comments
 (0)