diff --git a/docs/source/coding-toc.rst b/docs/source/coding-toc.rst deleted file mode 100644 index c77ba335..00000000 --- a/docs/source/coding-toc.rst +++ /dev/null @@ -1,14 +0,0 @@ -================= -Coding Principles -================= - -.. admonition:: ToDo - :class: custom-admonition-todo - - We need a brief intro. - -.. toctree:: - :maxdepth: 2 - - coding-principles/writing_good_commit_messages - coding-principles/testing diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst new file mode 100644 index 00000000..6a3cbaaf --- /dev/null +++ b/docs/source/contributing.rst @@ -0,0 +1,28 @@ +############ +Contributing +############ +The AboutCode organization welcomes you and your interest in contributing to our +organization. We are always looking for enthusiatic contributors and we are willing to +lend a helping hand if you have any questions or comments. That being said, here a few +resources to help you get started. + +1) Take a look through our public repos here: https://github.com/nexB/ + * Find one you are interested in and check out its open **Issues** +2) If you have specific questions browse through our documentation here: https://aboutcode.readthedocs.io/en/latest/ + * Depending on the project, there may be a seperate ReadTheDocs website + * If you did not find what you were looking for or you still have questions, + open an issue on the relevant repository, or ask directly via Gitter + +You can always interact with the AboutCode organization and our extended community on Gitter_ + +.. _Gitter: https://gitter.im/aboutcode-org/discuss + +************************ +Contribution Guidelines: +************************ + +.. toctree:: + :maxdepth: 2 + + contributing/writing_good_commit_messages + contributing/testing diff --git a/docs/source/coding-principles/testing.rst b/docs/source/contributing/testing.rst similarity index 100% rename from docs/source/coding-principles/testing.rst rename to docs/source/contributing/testing.rst diff --git a/docs/source/coding-principles/writing_good_commit_messages.rst b/docs/source/contributing/writing_good_commit_messages.rst similarity index 100% rename from docs/source/coding-principles/writing_good_commit_messages.rst rename to docs/source/contributing/writing_good_commit_messages.rst diff --git a/docs/source/index.rst b/docs/source/index.rst index 1474cce1..886bf912 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,6 @@ +####################### AboutCode Documentation -======================= +####################### Welcome to the AboutCode documentation. @@ -7,43 +8,54 @@ This set of documents provides an overview of the AboutCode Projects sponsored b AboutCode.org (https://www.aboutcode.org), as well as references to the various GitHub project sites that maintain the actual projects and their documentation. -All community contributions are welcome. Note that AboutCode.org is applying to participate in -the 2020 Google Season of Docs (`GSoD 2020 `_). +All community contributions are welcome. ---- +*************************** +AboutCode Organization Docs +*************************** + .. toctree:: - :maxdepth: 2 + :maxdepth: 1 + contributing + doc_guidelines aboutcode-project-overview aboutcode-data/abcd - coding-toc - doc_guidelines - gsoc-toc - gsod-toc license .. aboutcode-docs/home ---- + +********************** +AboutCode Project Docs +********************** + .. toctree:: - :maxdepth: 2 + :maxdepth: 1 aboutcode-toolkit/index - .. toctree:: - :maxdepth: 2 + :maxdepth: 1 deltacode/index ---- +************** +Community Docs +************** + .. toctree:: :maxdepth: 2 + gsoc-toc + gsod-toc contributor_project_ideas