diff --git a/index/howto_contribute.rst b/index/howto_contribute.rst new file mode 100644 index 000000000..723902a58 --- /dev/null +++ b/index/howto_contribute.rst @@ -0,0 +1,66 @@ +=============================================== +How to Contribute to the ownCloud Documentation +=============================================== + +You are encouraged to contribute to the ownCloud documentation by reporting +errors, adding new material, and writing tips and tricks. You must have a +`Github `_ account. + +Sharing tips and tricks is the easiest way to contribute, because these go in +the ownCloud Documentation Wiki. You can create and edit docs directly in the +Wiki. The subject matter is wide open: admin, user, mobile apps, LAMP stack, +development hints, installing ownCloud on diverse hardware such as Raspberry +Pi or giant clusters-- anything that is correct and useful. + +If you wish to contribute to the official Admin, User, or Desktop Client and +Mobile Apps manuals, that is a more complex process because you must +fork or branch the official repos, write your material, and create a pull +request. The manuals are written using Sphinx and RST markup. + +* The Admin and User manuals are in the + `owncloud/documentation `_ + repository on Github. Read the README.rst on the front page of the repo for + instructions on setting up your build enviroment. + +* The documentation for the desktop sync client is incorporated into the + `Desktop client repo `_. See the + README.md for instructions. + +* The documentation of the Android app is in the ``user_manual`` directory of + the `Android App repo `_. See the + README.md for instructions. + +* The documentation of the iOS app is in the ``user_manual`` directory of + the `iOS App repo `_. See the README.md for + instructions. + +Reporting Documentation Errors +------------------------------ + +If you find errors or omissions in the Admin, User, or Desktop Client and +Mobile Apps manuals, we encourage you to report them. (The Developer manual has +its own system and requirements; please consult the Developer manual for +details.) + +Please follow this template when reporting documentation errors: + +* First search the appropriate Github repository to see if your issue has + already been reported +* If it has not, open an Issue in the appropriate Github repository +* Provide the URL to the manual page and section. There are multiple release + versions of most of the manuals, so please mention exactly which one you are + reporting, and if it is the HTML or PDF version +* Quote the specific error +* Provide the correct solution, if you know it, and links to supporting + references. If you don't know the answer that is OK. +* Provide screenshots if they add useful information +* Provide your Web browser version and operating system & version +* Apply the appropriate Label to your Issue. Take some care with this so that + it gets the proper attention + +Reporting Documentation Suggestions +----------------------------------- + +If you don't have a specific problem or contribution, but wish to offer a +suggestion, open an Issue in the appropriate repository and apply the +appropriate label such as Enhancement, Question, or Discussion. \ No newline at end of file diff --git a/index/index.rst b/index/index.rst index 7ea96be03..7e852e615 100644 --- a/index/index.rst +++ b/index/index.rst @@ -16,12 +16,19 @@ Additional ownCloud Resources ----------------------------- * `Howto, demo, news, and Webinar videos - `_ + `_ * `What's New in ownCloud 8 `_ Video introduction to ownCloud 8. * `Where to get help `_ when the documentation is not enough. - + +------------------------------------------------ +Reporting Documentation Bugs & How to Contribute +------------------------------------------------ + +If you find an error or omission in any of the manuals, we welcome your bug +reports and contributions. Please see :doc:`howto_contribute` for instructions. + ------------ ownCloud 8.1 ------------