You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/index.rst
+20-34Lines changed: 20 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,51 +30,37 @@ Table of Contents
30
30
AboutCode Project Overview
31
31
**************************
32
32
33
-
[to come]
33
+
The primary current AboutCode projects are:
34
34
35
+
- `ScanCode Toolkit <https://github.com/nexB/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.
35
36
37
+
- Read more at: https://scancode-toolkit.readthedocs.io
38
+
- Get the code at: https://github.com/nexB/scancode-toolkit
36
39
40
+
|
37
41
38
-
.. Aboutcode Documentation Websites
39
-
.. --------------------------------
42
+
- `ScanCode.io <https://github.com/nexB/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.
40
43
41
-
.. | **Scancode-Toolkit** has its documentation website at ``scancode-toolkit.readthedocs.io``.
42
-
.. | `Click here <https://scancode-toolkit.readthedocs.io>`__ to visit the Scancode Documentation.
44
+
- Read more at: https://scancodeio.readthedocs.io
45
+
- Get the code at: https://github.com/nexB/scancode.io
43
46
44
-
.. | **Scancode-Workbench** has its documentation website at ``scancode-workbench.readthedocs.io``.
45
-
.. | `Click here <https://scancode-workbench.readthedocs.io>`__ to visit the Workbench Documentation.
47
+
|
46
48
47
-
.. Other Aboutcode Projects
48
-
.. ------------------------
49
+
- `ScanCode Workbench <https://github.com/nexB/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.
49
50
50
-
.. These are the Projects that don’t have a seperate documentation website currently.
51
-
.. Note that these might be outdated, as these documentations are updated in their wiki's primarily.
51
+
- Read more at: https://scancode-workbench.readthedocs.io
52
+
- Get the code at: https://github.com/nexB/scancode-workbench
52
53
53
-
.. .. toctree::
54
-
.. :maxdepth: 1
54
+
|
55
55
56
-
.. aboutcode-docs/home
57
-
.. aboutcode-toolkit/index
58
-
.. aboutcode-data/abcd
59
-
.. gsoc-toc
60
-
.. gsod-toc
56
+
- `VulnerableCode <https://github.com/nexB/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.
61
57
62
-
.. Documentation Guide
63
-
.. -------------------
58
+
- Read more at: https://vulnerablecode.readthedocs.io
59
+
- Get the code at: https://github.com/nexB/vulnerablecode
64
60
65
-
.. .. toctree::
66
-
.. :maxdepth: 2
61
+
|
67
62
68
-
.. aboutcode-project-overview
69
-
.. license
70
-
.. doc_maintenance
63
+
- `AboutCode Toolkit <https://github.com/nexB/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.
71
64
72
-
.. Indices and Tables
73
-
.. ------------------
74
-
75
-
.. * :ref:`genindex`
76
-
.. * :ref:`modindex`
77
-
78
-
.. .. _improve_docs:
79
-
80
-
.. .. include:: /rst_snippets/improve_docs.rst
65
+
- Read more at: https://aboutcode-toolkit.readthedocs.io
66
+
- Get the code at: https://github.com/nexB/aboutcode-toolkit
0 commit comments