Skip to content
Snippets Groups Projects
Commit a33ae4be authored by Amin Bandali's avatar Amin Bandali
Browse files

Move contribution guide to top-level and make it general

The idea is for this page to be a jumping point for all kinds of
contributions to Jami, in addition to the docs themselves.

Change-Id: I0f52ee8f0fde9443831886c353baf4d2b649a7d5
parent 479da838
No related branches found
No related tags found
No related merge requests found
####################################### ##################
How to contribute to this documentation Contribute to Jami
####################################### ##################
Contributions to Jami are always welcome and are much appreciated.
There are many ways to contribute to Jami, including reporting bugs
and issues, contributing code, helping package and maintain Jami for
your GNU/Linux distribution or other operating system, as well as
contributing to these very docs themselves.
Please see below for how to get started contributing to Jami!
.. contents::
:local:
:depth: 2
Reporting bugs and issues
=========================
Please see the :doc:`user/bug-report-guide` for step-by-step
instructions on how to report bugs and issues you encounter in Jami.
Contributing code
=================
TODO
Packaging Jami
==============
TODO
Contributing to this documentation
==================================
Contributions to these docs are always welcome and appreciated, from Contributions to these docs are always welcome and appreciated, from
small corrections to whole new chapters. small corrections to whole new chapters.
...@@ -13,10 +44,10 @@ every command. ...@@ -13,10 +44,10 @@ every command.
**TODO: internationalization** **TODO: internationalization**
Dependencies Dependencies
============ ------------
You will need Git installed and configured to use your SSH keypair, You will need Git installed and configured to use your SSH keypair,
and an account on the Jami `Gerrit <https://review.jami.net>`_, where and an account on the `Jami Gerrit <https://review.jami.net>`_, where
you would send your patches for review. If you need help with this, you would send your patches for review. If you need help with this,
see :doc:`the beginning of our patch submission guide see :doc:`the beginning of our patch submission guide
<how-to-submit-a-patch>` (TODO). <how-to-submit-a-patch>` (TODO).
...@@ -40,7 +71,7 @@ If you want to use the auto-build and auto-refresh feature, also install ...@@ -40,7 +71,7 @@ If you want to use the auto-build and auto-refresh feature, also install
$ pip install --upgrade sphinx-autobuild $ pip install --upgrade sphinx-autobuild
Cloning the repository Cloning the repository
====================== ----------------------
Clone the repository and configure the push settings like this: Clone the repository and configure the push settings like this:
...@@ -60,7 +91,7 @@ branch: ...@@ -60,7 +91,7 @@ branch:
$ git checkout -b my-example-change $ git checkout -b my-example-change
Editing a page Editing a page
============== --------------
Pages are written in either markdown or `reStructuredText Pages are written in either markdown or `reStructuredText
<https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_. <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_.
...@@ -70,7 +101,7 @@ raw source of the page and see how it was written. ...@@ -70,7 +101,7 @@ raw source of the page and see how it was written.
Go ahead and make your changes to the ``.rst`` or ``.md`` files. Go ahead and make your changes to the ``.rst`` or ``.md`` files.
Previewing your work Previewing your work
==================== --------------------
From the base of the repository, run: From the base of the repository, run:
...@@ -92,7 +123,7 @@ Keep this running in the background, then navigate to http://127.0.0.1:8000 ...@@ -92,7 +123,7 @@ Keep this running in the background, then navigate to http://127.0.0.1:8000
(*not* the local .html file). (*not* the local .html file).
Saving your work Saving your work
================ ----------------
.. code-block:: bash .. code-block:: bash
...@@ -113,7 +144,7 @@ For example: ...@@ -113,7 +144,7 @@ For example:
.. code-block:: none .. code-block:: none
Add new page section to guides/how-to-contribute-to-this-documentation Add new page section to contribute guide
Add a new section explaining how to add a new page to these docs, Add a new section explaining how to add a new page to these docs,
including listing it in the `toctree` directive of the containing including listing it in the `toctree` directive of the containing
...@@ -122,7 +153,7 @@ For example: ...@@ -122,7 +153,7 @@ For example:
GitLab: #123 GitLab: #123
Submitting a change Submitting a change
=================== -------------------
The first time you try to push your changes, Gerrit will complain that The first time you try to push your changes, Gerrit will complain that
you don't have a Change-Id in your commit, and provide an ``scp`` you don't have a Change-Id in your commit, and provide an ``scp``
...@@ -136,7 +167,7 @@ should be able to recommit and push your change: ...@@ -136,7 +167,7 @@ should be able to recommit and push your change:
Modifying your work Modifying your work
=================== -------------------
A reviewer may ask you to make changes to your patch before merging A reviewer may ask you to make changes to your patch before merging
it. This is no problem! Simply make the changes, ``git add`` them, it. This is no problem! Simply make the changes, ``git add`` them,
...@@ -146,21 +177,21 @@ existing newest commit rather than making a new commit. This is the ...@@ -146,21 +177,21 @@ existing newest commit rather than making a new commit. This is the
workflow for updating a proposed change when using Gerrit. workflow for updating a proposed change when using Gerrit.
Adding a page Adding a page
============= -------------
If you decide to add a whole new page to the documentation, you must If you decide to add a whole new page to the documentation, you must
also add it to the ``toctree`` directive of that chapter. also add it to the ``toctree`` directive of that chapter.
For instance, if you added a new guide called For instance, if you added a new page called
``hosting-jams-on-aws.md`` in the ``guides`` folder, you should add it ``hosting-jams-on-aws-guide.md`` to the Jami user manual in the
in the ``toctree`` directive of ``guides/index.rst``, *without* the ``user`` folder, you should add it in the ``toctree`` directive of
file extension: ``user/index.rst``, *without* the file extension:
.. code-block:: reST .. code-block:: reST
.. toctree:: .. toctree::
bug-report-guide
... ...
hosting-jams-on-aws bug-report-guide
hosting-jams-on-aws-guide
######
Guides
######
These are how-to guides that should `follow this format
<https://documentation.divio.com/how-to-guides/>`_.
.. toctree::
:maxdepth: 1
how-to-contribute-to-this-documentation
how-to-report-bugs
...@@ -8,8 +8,8 @@ This is the documentation for `Jami <https://jami.net>`_, free/libre ...@@ -8,8 +8,8 @@ This is the documentation for `Jami <https://jami.net>`_, free/libre
software for universal communication that respects the freedom and software for universal communication that respects the freedom and
privacy of its users. privacy of its users.
This documentation is community-driven and :doc:`anyone can This documentation is community-driven and :ref:`anyone can contribute
contribute<guides/how-to-contribute-to-this-documentation>`! <contribute:Contributing to this documentation>`!
.. note:: You may also be interested in the Jami `daemon .. note:: You may also be interested in the Jami `daemon
<https://docs.jami.net/doxygen/daemon/>`_ or `libclient <https://docs.jami.net/doxygen/daemon/>`_ or `libclient
...@@ -22,5 +22,4 @@ contribute<guides/how-to-contribute-to-this-documentation>`! ...@@ -22,5 +22,4 @@ contribute<guides/how-to-contribute-to-this-documentation>`!
:maxdepth: 2 :maxdepth: 2
user/index user/index
guides/index
technical/index technical/index
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment