@@ -4,65 +4,51 @@ title: Post your guide
Work your way through these steps to set up automated publishing to [18F
Pages](https://pages.18f.gov/) for your new guide:
- [Create the `18f-pages` branch. ](#create-18f-pages-branch)
- [Set the default branch. ](#set-default-branch)
- [Create the publishing webhook. ](#set-webhook)
- [Trigger a build. ](#trigger-a-build)
- [Add the guide to Federalist ](#federalist)
- [Set the `baseurl` configuration for Federalist builds ](#set-baseurl)
- [Add the new guide to 18F Guides. ](#add-new-guide)
### <a name="create-18f-pages-branch "></a>Create the `18f-pages` branch
### <a name="federalist "></a>Add the site to Federalist
**If you ran the `./go create_repo` command from the _GitHub setup_ chapter,
you can skip ahead to the [Create the publishing webhook](#set-webhook)
section. Otherwise, keep reading.**
The first step is to add your guide to [ Federalist ](https://federalist.18f.gov/).
Federalist will host your guide on [ 18F-pages ](https://pages.18f.gov), and
automatically re-build the guide in response to changes in its GitHub repository.
To publish your guide automatically to `pages.18f.gov` , you'll need
to create an `18f-pages` branch. You can do this using the GitHub interface by
clicking the **branch: master** button and entering `18f-pages` in the **Switch
branches/tags** drop-down box:
To get started, navigate to [federalist.18f.gov ](htttps://federalist.18f.gov)
and login. After you've logged in, click the "Add Website" button.
<img src="{{site.baseurl}}/images/18f-pages.png" alt="GitHub branch creation
interface">
<img src="{{site.baseurl}}/images/federalist-add-website.png" alt="The button for adding a website to Federalist">
### <a name="set-default-branch"></a>Set the default branch
On the next page, enter "18f" in the text field for the "Repository Owner's
Name" and the name of your guide's GitHub repository in the text field for the
"Repository's Name". It is important that you type "18f" with a lowercase "f",
or Federalist will not publish the guide to 18F pages.
_Note: If your repository is not just a Jekyll site — for example, if it's a project
repository with a `gh-pages` or `18f-pages` branch for documentation — you can
ignore this step._
<img src="{{site.baseurl}}/images/federalist-add-repository.png" alt="Federalist's interface for adding a new site">
You also need to set `18f-pages` branch as the default. First, click the **Settings** page button on the right side of the screen:<br/>
<img src="{{site.baseurl}}/images/gh-settings-button.png" alt="GitHub settings page button">
When you click "Submit repository-based site", your guide will be added to
Federalist.
This will present you with the **Options** page. In the **Settings** section, select `18f-pages` from the **Default branch** drop-down menu:<br/>
<img src="{{site.baseurl}}/images/gh-default-branch.png" alt="GitHub default branch option">
### <a name="set-baseurl"></a>Set the `baseurl` configuration for Federalist builds
Deleting the original `master` branch, both on GitHub and locally, is left as
an exercise for the reader. Doing so will help avoid confusion in the long run
but isn't strictly necessary.
Now that Federalist knows about your site, it's time to set the `baseurl` .
Click on your guide in the site list and then select "Settings" from the
sidebar. Scroll down the page until you see a text area for "Custom
Configuration". Here you will set the `baseurl` for your guide.
### <a name="set-webhook"></a>Create the publishing webhook
<img src="{{site.baseurl}}/images/federalist-custom-config.png" alt="Federalist's interface for adding custom configs to a site">
**18F Team members can skip this step!** Our pages are now building via an
organization-wide GitHub webhook. There is no need to set up a repo-specific
webhook anymore.
The value of the `baseurl` will be the name of the GitHub repository where your
guide lives.
**Other users running their own [18F/pages](https://github.com/18F/pages/)
instance:** You can either set up a webhook for your organization, or you can
add it per-repository as described below. The steps are nearly identical in
either case.
```yaml
baseurl : my-github-repo-name
```
Go into the **Webhooks & Services** section of the **Settings** section
and click the **Add webhook** button. On the following screen, set the
**Payload URL** to `https://pages.18f.gov/deploy` , leave the **Secret** field
blank, and click **Update webhook** :
<img src="{{site.baseurl}}/images/gh-webhook.png" alt="Set the GitHub webhook">
### <a name="trigger-a-build"></a>Trigger a build
With the webhook in place, push any update to your `18f-pages` branch to your
GitHub repository. Within seconds, your guide should appear at
`https://pages.18f.gov/MY-NEW-GUIDE` . Your guide is now live!
When the `baseurl` is set, Federalist will post guide to
`https://pages.18f.gov/<your-repo-name>` . This may take up to 5 to 10 minutes.
If you have any difficulty adding your guide, don't hesitate to head over to the
`#federalist-support` Slack channel to ask for help.
### <a name="add-new-guide"></a>Add the new guide to 18F Guides
0 comments on commit
b1660dd