Contributing to Site Stacker Docs
11 Jan 2017
Contributing to the content on the Site Stacker Documentation site is incredibly easy. There are 2 methods you can contribute:
- Edit directly on GitHub. This method doesn’t require any additional steps and it’s most suited for small changes and typo fixes.
- Clone the repository on your local machine. This method allows you to do more complex changes to the site, but requires some initial setup to get it working.
Edit on GitHub
This is the easiest method to change content on the site. Below are the advantages and disadvantages of this method.
|No setup required||Adding new categories or changing multiple articles is cumbersome|
|Suited for small changes and typo fixes||Difficult to preview changes|
|Every save creates a new commit in the repository|
|It’s very easy to break the site|
Edit a page
To edit a page, click on the Edit this page link next to the title:
From here, two things can happen:
- You’ll be presented with the GitHub editor
- You’ll be asked to fork the repository to propose changes
Edit in place
If you have write access to sitestacker/docs, you’ll be presented with the GitHub editor, and you can make changes right there:
Note: For information about the article syntax and content, see Writing an Article.
Important: Save only once
Since every change represents a commit, use the Preview changes tab to preview your changes and ONLY save when you’re satisfied with the changes.
Important: Add descriptive message on save
When you save, thus commit, add a descriptive commit subject and body, describing why you made the change.
After you save, you may have to wait a few minutes before you can see the changes on the site.
After you fork, you’ll have access to the GitHub editor where you can make the changes( see edit in place). When you’re satisfied, hit Propose changes and you’ll be presented with the next screen where you can review your changes and create the pull request:
You’re done! Once the pull request is merged, your changes will be live.
Note: Delete your fork
It’s recommended to delete your fork after you created the pull request, so next time you want to propose changes you’ll start fresh.
Clone the repository locally
Follow the instructions in the repository: https://github.com/sitestacker/docs/blob/gh-pages/README.md.