From 5a72525d7d432ff942a517eae445eab99e6e33a2 Mon Sep 17 00:00:00 2001 From: Joel Dudley Date: Mon, 14 Jan 2019 15:58:00 +0000 Subject: [PATCH] Moves Contrib and Network sections up in index. Makes requesting a contribution more prominent. (#4573) * Moves Contrib and Network sections up in index. Makes requesting a contribution more prominent. * Review feedback. --- docs/source/contributing-philosophy.rst | 8 ++++-- docs/source/contributing.rst | 29 +++++++++++---------- docs/source/index.rst | 34 ++++++++++++------------- 3 files changed, 39 insertions(+), 32 deletions(-) diff --git a/docs/source/contributing-philosophy.rst b/docs/source/contributing-philosophy.rst index 7d04a93efd..82d9acc278 100644 --- a/docs/source/contributing-philosophy.rst +++ b/docs/source/contributing-philosophy.rst @@ -44,8 +44,12 @@ Community maintainers ^^^^^^^^^^^^^^^^^^^^^ Current community maintainers: -* `Joel Dudley `_ - Contact via the `Corda Slack team `_, either in the - ``#community`` channel or via direct message using the handle ``@joel`` +* `Joel Dudley `_ - Contact me: + + * On the `Corda Slack team `_, either in the ``#community`` channel or by direct message using the handle + ``@joel`` + + * By email: joel.dudley at r3.com We anticipate additional maintainers joining the project in the future from across the community. diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 48b6c1b215..318a8e25cb 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -3,6 +3,22 @@ How to contribute .. contents:: +Identifying an area to contribute +--------------------------------- +There are several ways to identify an area where you can contribute to Corda: + +* The easiest is just to message one of the :ref:`Community Maintainers ` saying "I want to help!". They'll work + with you to find an area for you to contribute + +* If you have a specific contribution in mind, confirm whether the contribution is appropriate first by reaching out in the + ``#contributing`` channel of the `Corda Slack `_ or contacting one of the + :ref:`Community Maintainers ` directly + +* If you do not have a specific contribution in mind, you can also browse the issues labelled as ``help wanted`` on the + `Corda GitHub issues `_ page + + * Issues that additionally have the ``good first issue`` label are considered ideal for first-timers + Contribution guidelines ----------------------- We believe one of the things that makes Corda special is its coherent design and we seek to retain this defining characteristic. From the @@ -27,19 +43,6 @@ outset we defined some guidelines to ensure new contributions only ever enhance `our Jira work tracking system is public `_. If in doubt, reach out to one of the :ref:`Community Maintainers ` -Identifying an area to contribute ---------------------------------- -There are two ways to identify an area where you can contribute to Corda: - -* If there is a specific contribution you would like to make, you should first confirm whether the contribution is appropriate by reaching - out in the ``#contributing`` channel of the `Corda Slack `_ or contacting one of the - :ref:`Community Maintainers ` directly - -* If you do not have a specific contribution in mind, you can browse issues labelled as ``help wanted`` in the - `Corda GitHub Issues `_ - - * Issues that additionally have the ``good first issue`` label are considered ideal for first-timers - Making the required changes --------------------------- You should make your changes as follows: diff --git a/docs/source/index.rst b/docs/source/index.rst index 9afba08ea6..2d5efdc8b9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -71,6 +71,23 @@ We look forward to seeing what you can do with Corda! release-notes.rst changelog.rst +.. conditional-toctree:: + :caption: Participate + :maxdepth: 2 + :if_tag: htmlmode + + contributing-index.rst + corda-repo-layout.rst + deterministic-modules.rst + changelog + +.. conditional-toctree:: + :caption: Corda Network + :maxdepth: 2 + :if_tag: htmlmode + + corda-network/index.md + .. conditional-toctree:: :caption: Design docs :maxdepth: 2 @@ -90,20 +107,3 @@ We look forward to seeing what you can do with Corda! design/data-model-upgrades/signature-constraints.md design/data-model-upgrades/package-namespace-ownership.md design/targetversion/design.md - -.. conditional-toctree:: - :caption: Participate - :maxdepth: 2 - :if_tag: htmlmode - - contributing-index.rst - corda-repo-layout.rst - deterministic-modules.rst - changelog - -.. conditional-toctree:: - :caption: Corda Network - :maxdepth: 2 - :if_tag: htmlmode - - corda-network/index.md \ No newline at end of file