diff --git a/docs/admin/troubleshooting.rst b/docs/admin/troubleshooting.rst index b547df6eb..a8c6f2546 100644 --- a/docs/admin/troubleshooting.rst +++ b/docs/admin/troubleshooting.rst @@ -159,6 +159,6 @@ similar issues before doing that, and use the issue tracker only to report bugs, Improving this documentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you feel like something should be improved in this document (and in the documentation in general), feel free to `edit -it `_ and open a Merge Request. If you lack time or skills -to do that, you can open an issue to discuss that, and someone else will do it. +If you feel like something should be improved in this document (and in the documentation in general), feel free to :doc:`contribute to the documentation <../documentation/creating>`. +If you're not comfortable contributing or would like to ask somebody else to do it, feel free to :doc:`request a change in documentation <../documentation/identifying>`. + diff --git a/docs/documentation/creating.rst b/docs/documentation/creating.rst new file mode 100644 index 000000000..57045896a --- /dev/null +++ b/docs/documentation/creating.rst @@ -0,0 +1,129 @@ +Adding New Documents +==================== + +Writing Documents +----------------- + +Before you start writing documents: + +- Make sure you have all the necessary information and :doc:`tools you need ` to get started +- Check the `current documents `_ carefully to make sure you're not repeating something somebody has already said +- Familiarize yourself with :doc:`reStructuredText ` and :doc:`the recommended document style