Skip to content

Commit e8e6a75

Browse files
chinyeunglichinyeungli
committed
#197 - Archive GSOC information on aboutcode RTD home page and promote AboutCode projects to homepage
Signed-off-by: Chin Yeung Li <tli@nexb.com>
1 parent 4ea5f5d commit e8e6a75

File tree

7 files changed

+82
-39
lines changed

7 files changed

+82
-39
lines changed

‎docs/source/aboutcode-project-overview.rst‎

Lines changed: 8 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,11 @@ AboutCode Project Overview
66

77
The primary current AboutCode projects are:
88

9-
- `ScanCode Toolkit <https://github.com/aboutcode-org/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.
10-
11-
- Read more at: https://scancode-toolkit.readthedocs.io
12-
- Get the code at: https://github.com/aboutcode-org/scancode-toolkit
13-
14-
|
15-
16-
- `ScanCode.io <https://github.com/aboutcode-org/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.
17-
18-
- Read more at: https://scancodeio.readthedocs.io
19-
- Get the code at: https://github.com/aboutcode-org/scancode.io
20-
21-
|
22-
23-
- `ScanCode Workbench <https://github.com/aboutcode-org/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.
24-
25-
- Read more at: https://scancode-workbench.readthedocs.io
26-
- Get the code at: https://github.com/aboutcode-org/scancode-workbench
27-
28-
|
29-
30-
- `VulnerableCode <https://github.com/aboutcode-org/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.
31-
32-
- Read more at: https://vulnerablecode.readthedocs.io
33-
- Get the code at: https://github.com/aboutcode-org/vulnerablecode
34-
35-
|
36-
37-
- `AboutCode Toolkit <https://github.com/aboutcode-org/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.
38-
39-
- Read more at: https://aboutcode-toolkit.readthedocs.io
40-
- Get the code at: https://github.com/aboutcode-org/aboutcode-toolkit
41-
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
aboutcode-projects/scancode-toolkit-project
13+
aboutcode-projects/scancodeio-project
14+
aboutcode-projects/scancode-workbench-project
15+
aboutcode-projects/vulnerablecode-project
16+
aboutcode-projects/aboutcode-toolkit-project

‎docs/source/aboutcode-projects/aboutcode-toolkit-project.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _aboutcode-toolkit-project:
2+
3+
AboutCode Toolkit
4+
=================
5+
6+
`AboutCode Toolkit <https://github.com/aboutcode-org/aboutcode-toolkit>`_:
7+
AboutCode Toolkit provides a set of command-line tools to generate
8+
Attribution documents and software BOM reports from any source. It also
9+
provides a standard ABCD format for yaml files to document software
10+
provenance and license metadata in a codebase where this is not already
11+
covered by a package manager.
12+
13+
- Read more at: https://aboutcode-toolkit.readthedocs.io
14+
- Get the code at: https://github.com/aboutcode-org/aboutcode-toolkit

‎docs/source/aboutcode-projects/scancode-toolkit-project.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _scancode-toolkit-project:
2+
3+
ScanCode Toolkit
4+
================
5+
6+
`ScanCode Toolkit <https://github.com/aboutcode-org/scancode-toolkit>`_:
7+
is a code scanning "engine" and command-line tool to detect the
8+
provenance and license of code and its dependencies. ScanCode TK is a
9+
command-line tool with many scanning options and output formats (JSON,
10+
HTML, CSV or SPDX). ScanCode detects licenses, copyrights, package
11+
manifests and more in both source code and binary files. There is already
12+
a large set of pre- and post-plugins and you can also create your own
13+
plugins.
14+
15+
- Read more at: https://scancode-toolkit.readthedocs.io
16+
- Get the code at: https://github.com/aboutcode-org/scancode-toolkit

‎docs/source/aboutcode-projects/scancode-workbench-project.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _scancode-workbench-project:
2+
3+
ScanCode Workbench
4+
==================
5+
6+
`ScanCode Workbench
7+
<https://github.com/aboutcode-org/scancode-workbench>`_: is a desktop
8+
application (based on Electron) to review the results of a scan and
9+
document your conclusions about the origin and license of software
10+
components and packages.
11+
12+
- Read more at: https://scancode-workbench.readthedocs.io
13+
- Get the code at: https://github.com/aboutcode-org/scancode-workbench

‎docs/source/aboutcode-projects/scancodeio-project.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _scancodeio-project:
2+
3+
ScanCode.io
4+
===========
5+
6+
`ScanCode.io <https://github.com/aboutcode-org/scancode.io>`_: is a Cloud
7+
application server that automates Software Composition Analysis with
8+
pipelines. ScanCode.io has standard pipelines for Docker and VM images,
9+
root filesystems and packages. ScanCode.io organizes these complex code
10+
analyses as scripted pipelines and stores the results in its database for
11+
automated code analysis.
12+
13+
- Read more at: https://scancodeio.readthedocs.io
14+
- Get the code at: https://github.com/aboutcode-org/scancode.io

‎docs/source/aboutcode-projects/vulnerablecode-project.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _vulnerablecode-project:
2+
3+
VulnerableCode
4+
==============
5+
6+
`VulnerableCode <https://github.com/aboutcode-org/vulnerablecode>`_: is an
7+
early stage project to provide a free and open source database of
8+
vulnerabilities and the packages they impact with tools to aggregate and
9+
correlate those vulnerabilities. The initial development of VulnerableCode
10+
was supported by the NLNet Foundation.
11+
12+
- Read more at: https://vulnerablecode.readthedocs.io
13+
- Get the code at: https://github.com/aboutcode-org/vulnerablecode

‎docs/source/index.rst‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,18 @@ Overview
2121
********
2222

2323
.. toctree::
24-
:maxdepth: 2
24+
:maxdepth: 3
2525

2626
aboutcode-project-overview
2727

28-
**************************
29-
Contributing and GSoC/GSoD
30-
**************************
28+
************
29+
Contributing
30+
************
3131

3232
.. toctree::
3333
:maxdepth: 3
3434

3535
contributing
36-
archive/gsoc-toc
37-
archive/gsod-toc
3836

3937
******
4038
Others

0 commit comments

Comments
 (0)