diff --git a/docs/source/aboutcode-data/abcd.rst b/docs/source/aboutcode-data/abcd.rst index f187303e..0600862a 100644 --- a/docs/source/aboutcode-data/abcd.rst +++ b/docs/source/aboutcode-data/abcd.rst @@ -1,7 +1,7 @@ .. _aboutcode_data: -AboutCode Data : ABCD -===================== +AboutCode Data Structure (ABCD) +=============================== Summary ------- diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index 6a3cbaaf..9a70caa2 100644 --- a/docs/source/contributing.rst +++ b/docs/source/contributing.rst @@ -1,6 +1,7 @@ -############ -Contributing -############ +######################### +Contributing to AboutCode +######################### + 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 diff --git a/docs/source/index.rst b/docs/source/index.rst index a4c8ee37..b57a9613 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,86 +1,66 @@ -####################### -AboutCode Documentation -####################### +######### +AboutCode +######### -Welcome to the AboutCode documentation. +Welcome to the AboutCode documentation homepage. `AboutCode.org `_ is a community of open source developers who are trying to make open source easier to use by providing open source tools to discover, identify and track open source components (aka Software Composition Analysis – SCA). AboutCode is the collective name for these open source tools. -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. +This home page provides a directory of our major projects and their documentation on ReadTheDocs plus information about how to contribute to AboutCode documentation All community contributions are welcome. + ---- -*************************** -AboutCode Organization Docs -*************************** +***************** +Table of Contents +***************** .. toctree:: :maxdepth: 1 - contributing - doc_guidelines aboutcode-project-overview aboutcode-data/abcd + contributing + doc_guidelines license -.. aboutcode-docs/home - ---- -************** -Community Docs -************** - -.. toctree:: - :maxdepth: 2 - - gsoc-toc - gsod-toc - contributor_project_ideas +************************** +AboutCode Project Overview +************************** +The primary current AboutCode projects are: -.. Aboutcode Documentation Websites -.. -------------------------------- +- `ScanCode Toolkit `_: is a code scanning "engine" and command-line tool to detect the provenance and license of code and its dependencies. ScanCode TK is a command-line tool with many scanning options and output formats (JSON, HTML, CSV or SPDX). ScanCode detects licenses, copyrights, package manifests and more in both source code and binary files. There is already a large set of pre- and post-plugins and you can also create your own plugins. -.. | **Scancode-Toolkit** has its documentation website at ``scancode-toolkit.readthedocs.io``. -.. | `Click here `__ to visit the Scancode Documentation. + - Read more at: https://scancode-toolkit.readthedocs.io + - Get the code at: https://github.com/nexB/scancode-toolkit -.. | **Scancode-Workbench** has its documentation website at ``scancode-workbench.readthedocs.io``. -.. | `Click here `__ to visit the Workbench Documentation. +| -.. Other Aboutcode Projects -.. ------------------------ +- `ScanCode.io `_: is a Cloud application server that automates Software Composition Analysis with pipelines. ScanCode.io has standard pipelines for Docker and VM images, root filesystems and packages. ScanCode.io organizes these complex code analyses as scripted pipelines and stores the results in its database for automated code analysis. -.. These are the Projects that don’t have a seperate documentation website currently. -.. Note that these might be outdated, as these documentations are updated in their wiki's primarily. + - Read more at: https://scancodeio.readthedocs.io + - Get the code at: https://github.com/nexB/scancode.io -.. .. toctree:: -.. :maxdepth: 1 +| -.. aboutcode-docs/home -.. aboutcode-toolkit/index -.. aboutcode-data/abcd -.. gsoc-toc -.. gsod-toc +- `ScanCode Workbench `_: is a desktop application (based on Electron) to review the results of a scan and document your conclusions about the origin and license of software components and packages. -.. Documentation Guide -.. ------------------- + - Read more at: https://scancode-workbench.readthedocs.io + - Get the code at: https://github.com/nexB/scancode-workbench -.. .. toctree:: -.. :maxdepth: 2 +| -.. aboutcode-project-overview -.. license -.. doc_maintenance +- `VulnerableCode `_: is an early stage project to provide a free and open source database of vulnerabilities and the packages they impact with tools to aggregate and correlate those vulnerabilities. The initial development of VulnerableCode was supported by the NLNet Foundation. -.. Indices and Tables -.. ------------------ + - Read more at: https://vulnerablecode.readthedocs.io + - Get the code at: https://github.com/nexB/vulnerablecode -.. * :ref:`genindex` -.. * :ref:`modindex` +| -.. .. _improve_docs: +- `AboutCode Toolkit `_: AboutCode Toolkit provides a set of command-line tools to generate Attribution documents and software BOM reports from any source. It also provides a standard ABCD format for yaml files to document software provenance and license metadata in a codebase where this is not already covered by a package manager. -.. .. include:: /rst_snippets/improve_docs.rst + - Read more at: https://aboutcode-toolkit.readthedocs.io + - Get the code at: https://github.com/nexB/aboutcode-toolkit