-
Notifications
You must be signed in to change notification settings - Fork 65
Add a Guide article
Jeff Fredrickson edited this page Nov 30, 2017
·
3 revisions
The Tech Guides section of the website serves as a knowledge base. You can write articles for the Tech Guides simply by adding a new Markdown file to the _guides
directory. For instance, say you want to write an article on "API Standards". Copy the file _guides/_TEMPLATE.md
to a new file, _guides/api-standards.md
, then follow the instructions in the file.
The template file includes some helpful information on how to get started. Also, see the Style Guide to learn how to keep all guide pages consistent in appeareance.
- Create a feature branch based on the
master
branch. Prefix it with your initials, followed by_
, and then a brief summary of the changes you're going to make, e.g.,sc_new-agile-guide
(see branching tutorial). - Make the following changes in your feature branch, not on
master
:- Go to the
_guides
folder. - Click the Create new file button.
- Name the file something relevant to the guide, such as
agile-guide.md
. It should be lowercase, use hyphens instead of spaces, and end with the extension.md
. - Optionally, you can get started by pasting in the contents of
_TEMPLATE.md
. - When you are done, commit the file with a descriptive message.
- Go to the
- Preview your changes at https://federalist.18f.gov/preview/gsa/cto-website/BRANCH_NAME/ (where BRANCH_NAME is the name of your feature branch, e.g.,
sc_new-agile-guide
) - Open a pull request to merge the feature branch to
master
(see pull request tutorial).
- Create a feature branch based on the
master
branch. Prefix it with your initials, followed by_
, and then a brief summary of the changes you're going to make (e.g.,sc_update-agile-guide
). View this tutorial for help in creating branches on GitHub. - Make the following changes in your feature branch, not on
master
:- Go to the
_guides
folder. - Edit the Guide file.
- When you are done, commit the file with a descriptive message.
- Go to the
- Preview your changes at https://federalist.18f.gov/preview/gsa/cto-website/BRANCH_NAME/
- Open a pull request to merge the feature branch to
master
(see pull request tutorial).