farmOS.org

This repository contains all the code and content used to build http://farmOS.org.

It uses mkdocs to convert simple markdown files into static HTML files.

To get started contributing to this project, fork it 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.org.git farmOS.org
$ cd farmOS.org
$ git remote add sandbox git@github.com:<username>/farmOS.org.git
$ mkdocs serve

Your local farmOS.org 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