Permalink
Browse files

added instructions for adding to documentation

  • Loading branch information...
camd committed Mar 7, 2013
1 parent 6f5df28 commit 25b030131411f48ad86807f01ea6e2d4b51570b9
Showing with 26 additions and 0 deletions.
  1. +26 −0 docs/development.rst
View
@@ -20,6 +20,32 @@ To connect with MozTrap development, visit the ``#moztrap`` IRC channel at
.. _Pivotal Tracker backlog: https://www.pivotaltracker.com/projects/280483
+Updating this documentation
+---------------------------
+
+MozTrap documentation is hosted on ReadTheDocs.org and is maintained in the
+MozTrap repo. So updating the docs involves forking the repo, changing the
+appropriate reStructuredText documents and submitting a pull request. Then
+the team will review them and merge them after any needed adjustments are made.
+
+So here are your steps:
+
+ #. fork the `MozTrap repo`_
+ #. make any changes in the ``/docs`` folder using `Sphinx and
+ reStructuredText`_ formatting
+ #. test that your changes are correctly formatted by installing the python
+ Sphinx package (in the repo's ``requirements.txt`` document) by typing
+ ``make html`` in that same ``/docs`` folder
+ #. load the file: ``/docs/_build/html/index.html`` into your browser
+ (it's `Firefox`_, right?) to test your changes
+ #. submit your pull request and it will be reviewed shortly
+ #. receive a big thanks for helping!!
+
+.. _MozTrap repo: https://github.com/mozilla/moztrap
+.. _Sphinx and reStructuredText: http://sphinx-doc.org/rest.html
+.. _Firefox: http://www.mozilla.org/en-US/firefox/new/
+
+
Coding standards
----------------

0 comments on commit 25b0301

Please sign in to comment.