CORDA-1585 - Tidy up participate docs (#3682)

* CORDA-1585 - Tidy up participate docs + pdf toctree backport (#3674)

* Fix TOC for HTML and PDF (Backport from Enterprise docs)

* Tidy up participate section

* Address review comments

# Conflicts:
#	docs/source/building-container-images.rst
#	docs/source/conf.py
#	docs/source/contributing.rst
#	docs/source/getting-set-up.rst
#	docs/source/index.rst
#	docs/source/release-process-index.rst

* Fixing merge issue

* Add release process changes into index
This commit is contained in:
Anthony Keenan 2018-07-27 10:54:18 +01:00 committed by Katelyn Baker
parent 143e6d3265
commit 53b33f138b
4 changed files with 24 additions and 13 deletions

View File

@ -0,0 +1,17 @@
Contributing
============
Corda is an open-source project and contributions are welcome. Our contributing philosophy is described in
`CONTRIBUTING.md <https://github.com/corda/corda/blob/master/CONTRIBUTING.md>`_. This guide explains the mechanics
of contributing to Corda.
.. toctree::
:maxdepth: 1
contributing
building-corda
testing
codestyle
building-the-docs
api-scanner
contributing-flow-state-machines

View File

@ -1,14 +1,9 @@
Contributing
============
Corda is an open-source project and contributions are welcome. Our contributing philosophy is described in
`CONTRIBUTING.md <https://github.com/corda/corda/blob/master/CONTRIBUTING.md>`_. This guide explains the mechanics
of contributing to Corda.
.. contents::
How to contribute
=================
Identifying an area to contribute
---------------------------------
There are several ways to identify an area where you can contribute to Corda:
* Browse issues labelled as ``good first issue`` in the
@ -26,7 +21,8 @@ Making the required changes
1. Create a fork of the master branch of the `Corda repo <https://github.com/corda/corda>`_
2. Clone the fork to your local machine
3. Make the changes, in accordance with the :doc:`code style guide </codestyle>`
3. Build Corda by following the instructions :doc:`here </building-corda>`
4. Make the changes, in accordance with the :doc:`code style guide </codestyle>`
Things to check
^^^^^^^^^^^^^^^

View File

@ -41,6 +41,7 @@ We look forward to seeing what you can do with Corda!
tools-index.rst
node-internals-index.rst
component-library-index.rst
contributing-index.rst
release-process-index.rst
faq.rst
troubleshooting.rst

View File

@ -5,7 +5,4 @@ Release process
:maxdepth: 1
release-notes
changelog
contributing
codestyle
testing
changelog