From 23840ea4050c95b4bfeb138676ef8586122bc743 Mon Sep 17 00:00:00 2001 From: Jeremy Cline Date: Mar 03 2017 14:56:49 +0000 Subject: Update the README to clarify where to contribute fixes #8 Signed-off-by: Jeremy Cline --- diff --git a/README.rst b/README.rst index edbe485..db3980b 100644 --- a/README.rst +++ b/README.rst @@ -1,3 +1,4 @@ +=================================== Fedora Infrastructure Documentation =================================== .. image:: https://readthedocs.org/projects/fedora-infra-docs/badge/?version=latest @@ -9,8 +10,23 @@ Infrastructure deploys and covers application development best practices for those applications we maintain ourselves. This is designed to be consumed as a Sphinx documentation project. Documentation -is available online on `pagure `_ and on -`Read the Docs `_. +is available online on `Pagure`_ and on `Read the Docs`_. + + +Contributing +============ + +This project is maintained on `our Pagure repository`_. Contributions are +reviewed and accepted by submitting a `pull request`_ to our Pagure repository. +If you're not familiar with the pull request workflow, check out the Pagure +`documentation on pull requests`_. + +Documentation is written in reStructedText. See Sphinx's `reStructuredText +Primer`_ for a brief introduction to the concepts and format. + + +Local Builds +============ To build the documentation locally, create a virtualenv and install the requirements:: @@ -18,7 +34,7 @@ To build the documentation locally, create a virtualenv and install the requirem $ mkvirtualenv -a $(pwd) infra-docs $ pip install -r requirements.txt -then build the documentation and open it in a browser of your choice:: +Then build the documentation and open it in a browser of your choice:: $ cd docs $ make html @@ -35,3 +51,13 @@ virtual environment with:: It will automatically change the current working directory to the repository root. + + +.. _Pagure: https://docs.pagure.org/infra-docs/ +.. _Read the Docs: https://fedora-infra-docs.readthedocs.io/ +.. _our Pagure repository: https://pagure.io/infra-docs +.. _pull request: https://pagure.io/infra-docs/pull-requests +.. _documentation on pull requests: + https://docs.pagure.org/pagure/usage/pull_requests.html +.. _reStructuredText Primer: + http://www.sphinx-doc.org/en/stable/rest.html