Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
remove references to 18F Pages
- Loading branch information
|
@@ -5,7 +5,7 @@ To add new pages, create a |
|
|
[Markdown](http://daringfireball.net/projects/markdown/syntax) file in the |
|
|
`_pages/` directory of the repository. For example, the Markdown text for |
|
|
this page is |
|
|
[`_pages/new-page.md`](https://github.com/18F/guides-template/blob/18f-pages/_pages/add-a-new-page.md). |
|
|
[`_pages/new-page.md`](https://github.com/18F/guides-template/blob/master/_pages/add-a-new-page.md). |
|
|
|
|
|
The Markdown document begins with this [YAML front |
|
|
matter](http://jekyllrb.com/docs/frontmatter/): |
|
@@ -19,7 +19,7 @@ title: {{ page.title }} |
|
|
For most pages this will suffice. The URL of the page will match the file path |
|
|
relative to the `_pages` directory, minus the `.md` extension. For example, |
|
|
the source for this page appears as |
|
|
[`{{ page.path }}`]({{ site.repos[0].url }}/tree/18f-pages/{{ page.path }}). |
|
|
[`{{ page.path }}`]({{ site.repos[0].url }}/tree/master/{{ page.path }}). |
|
|
|
|
|
For the home page of your guide, the front matter should contain a |
|
|
`permalink: /` entry like this: |
|
|
|
@@ -5,7 +5,7 @@ title: Introduction |
|
|
Use this template to create [18F Guides](http://pages.18f.gov/guides/) |
|
|
and other 18F-branded documentation available on [18F |
|
|
Pages](https://pages.18f.gov/). It's structured like an 18F Guides guide, |
|
|
and it walks you through the process of creating and publishing an 18F Pages document based on |
|
|
and it walks you through the process of creating and publishing a guide based on |
|
|
the same theme. |
|
|
|
|
|
The template is derived from [CFPB/DOCter](https://github.com/CFPB/DOCter). |
|
|
|
@@ -11,8 +11,7 @@ Pages](https://pages.18f.gov/) for your new guide: |
|
|
### <a name="federalist"></a>Add the site to Federalist |
|
|
|
|
|
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. |
|
|
Federalist will automatically re-build the guide in response to changes in its GitHub repository. |
|
|
|
|
|
To get started, navigate to [federalist.18f.gov](htttps://federalist.18f.gov) |
|
|
and login. After you've logged in, click the "Add Website" button. |
|
@@ -22,7 +21,7 @@ and login. After you've logged in, click the "Add Website" button. |
|
|
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. |
|
|
or Federalist will not publish the guide. |
|
|
|
|
|
<img src="{{site.baseurl}}/images/federalist-add-repository.png" alt="Federalist's interface for adding a new site"> |
|
|
|
|
@@ -55,7 +54,7 @@ If you have any difficulty adding your guide, don't hesitate to head over to the |
|
|
You've reached the final step! Add an entry to the `navigation:` list of [18F |
|
|
Guides](https://guides.18f.gov/) linking to your new guide. You can [use |
|
|
this link to edit the file directly in |
|
|
GitHub](https://github.com/18F/guides/edit/18f-pages/_config.yml): |
|
|
GitHub](https://github.com/18F/guides/edit/master/_config.yml): |
|
|
|
|
|
<img src="{{site.baseurl}}/images/gh-add-guide.png" alt="Add the new guide to 18F Guides using the GitHub text editor"> |
|
|
|
|
|
|
@@ -107,13 +107,12 @@ repos:{% for i in site.repos %} |
|
|
|
|
|
The `back_link:` property produces the _Read more 18F Guides_ link just under |
|
|
the title of the guide at the top of the page. If your document is not |
|
|
actually an 18F Guide, you may change this property to link to 18F Pages— or |
|
|
any other collection of documents to which your new "guide" actually belongs. |
|
|
actually an 18F Guide, you may change this property to link to any other collection of documents to which your new "guide" actually belongs. |
|
|
|
|
|
### <a name="set-google-analytics"></a>Optional: update `google_analytics_ua:` |
|
|
|
|
|
The `google_analytics_ua:` property defaults to the Google Analytics account |
|
|
identifier for all 18F Pages sites. You can override it if you prefer. |
|
|
identifier for all 18F Federalist sites. You can override it if you prefer. |
|
|
|
|
|
### Next steps |
|
|
|
|
|