search

farmOS / farm_grazing

Rotational grazing planning module for farmOS v1. For newer efforts, see https://drupal.org/project/farm_grazing_plan
4 stars 1 forks source link

Create documentation page on farmOS.org #5

Open mstenta opened 6 years ago

mstenta commented 6 years ago

farmOS.org has a section in the user guide for "Community modules" (modules that are not part of farmOS core): http://farmos.org/guide/contrib/

Currently there's only a page in there for the Produce Safety module (https://github.com/farmOS/farm_produce_safety).

It would be great to have one for the Grazing module too. Perhaps we can use some of the content that Jody puts together.

mstenta commented 6 years ago

All the pages in farmOS.org are managed in this Github repo as markdown files: https://github.com/farmOS/farmOS.org

For example, here is the page for the Produce Safety module: https://raw.githubusercontent.com/farmOS/farmOS.org/7.x-1.x/docs/guide/contrib/produce-safety.md

To create one for this grazing module, three steps are required:

  1. Create a new file calledgrazing.md that contains the documentation.
  2. Add a line to the root mkdocs.yml file so that it shows up in the menu: https://github.com/farmOS/farmOS.org/blob/7.x-1.x/mkdocs.yml
  3. Add a link in the "Community modules" page itself: http://farmos.org/guide/contrib/

That could all be done in a branch of the farmOS.org repository, and then merged in and pushed live.