Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add instructions about how to update documentation to documentation
- Loading branch information
1 parent
4c00f6d
commit 2ce6c8e
Showing
3 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
site/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Documentation | ||
|
||
In addition to the code for farmOS 2.x, this repository includes the source files of the | ||
documentation which is hosted at [http://2x.farmos.org](http://2x.farmos.org). | ||
|
||
It uses [mkdocs](http://www.mkdocs.org) to convert simple markdown files into | ||
static HTML files. | ||
|
||
To get started contributing to the farmOS 2.x documentation, fork | ||
[farmOS](https://github.com/farmOS/farmOS/tree/2.x) on Github. Then install mkdocs and | ||
clone this repo: | ||
|
||
$ brew install python # For OSX users | ||
$ sudo apt-get install python-pip # For Debian/Ubuntu users | ||
$ sudo pip install mkdocs mkdocs-bootstrap mkdocs-bootswatch | ||
$ git clone https://github.com/farmOS/farmOS.git farmOS | ||
$ cd farmOS | ||
$ git checkout 2.x | ||
$ git remote add sandbox git@github.com:<username>/farmOS.git | ||
$ mkdocs serve | ||
|
||
Your local farmOS 2.x documentation site should now be available for browsing: | ||
http://127.0.0.1:8000/. When you find a typo, an error, unclear or missing | ||
explanations or instructions, hit ctrl-c, to stop the server, and start editing. | ||
Find the page you’d like to edit; everything is in the docs/ directory. Make | ||
your changes, commit and push them, and start a pull request: | ||
|
||
$ git checkout -b fix_typo # Create a new branch for your changes. | ||
... # Make your changes. | ||
$ mkdocs build --clean; mkdocs serve # Go check your changes. | ||
$ git diff # Make sure there aren’t any unintended changes. | ||
... | ||
$ git commit -am "Fixed typo." # Useful commit message are a good habit. | ||
$ git push sandbox fix_typo # Push your new branch up to your Github sandbox. | ||
|
||
Visit your fork on Github and start a Pull Request. | ||
|
||
For more information on writing and managing documentation with mkdocs, read the | ||
official mkdocs documentation: [http://www.mkdocs.org](http://www.mkdocs.org) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters