Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions docs/source/coding-toc.rst

This file was deleted.

28 changes: 28 additions & 0 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
@@ -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
34 changes: 23 additions & 11 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,49 +1,61 @@
#######################
AboutCode Documentation
=======================
#######################

Welcome to the AboutCode documentation.

This set of documents provides an overview of the AboutCode Projects sponsored by
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 <https://developers.google.com/season-of-docs>`_).
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


Expand Down