Skip to content

Commit faf767b

Browse files
committed
Issue #27 Introduce start-scanning-code and additional projects
1 parent 3392ba3 commit faf767b

File tree

4 files changed

+71
-0
lines changed

4 files changed

+71
-0
lines changed

docs/source/aboutcode-project-overview.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Supporting AboutCode Projects
2323
.. toctree::
2424
:maxdepth: 2
2525

26+
aboutcode-projects/license-expression-project
27+
aboutcode-projects/scancode-action-project
2628
aboutcode-projects/aboutcode-toolkit-project
2729

2830
Getting Started
@@ -31,6 +33,8 @@ Getting Started
3133
.. toctree::
3234
:maxdepth: 2
3335

36+
getting-started/start-scanning-code
37+
3438
getting-started/manage-license-policies
3539

3640
getting-started/create-sboms
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. _license-expression-project:
2+
3+
license-expression
4+
==================
5+
6+
`license-expression <https://github.com/aboutcode-org/license-expression>`_: is a
7+
comprehensive utility library to parse, compare, simplify and normalize license
8+
expressions (such as SPDX license expressions) using boolean logic.
9+
10+
- Read more at: https://github.com/aboutcode-org/license-expression
11+
- Get the code at: https://github.com/aboutcode-org/license-expression/releases
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. _scancode-action-project:
2+
3+
scancode-action
4+
===============
5+
6+
`scancode-action <https://github.com/aboutcode-org/scancode-action>`_: enables
7+
you to run ScanCode.io pipelines from your workflows.
8+
9+
- Read more at: https://github.com/aboutcode-org/scancode-action
10+
- Get the code at: https://github.com/aboutcode-org/scancode-action/releases
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
.. _start-scanning-code:
2+
3+
Use AboutCode to Start Scanning Code
4+
====================================
5+
You can use **ScanCode.io** to identify all the licenses associated with a package,
6+
codebase, or container. ScanCode.io will also identify software vulnerabilities. With its
7+
library of standard and custom pipelines, ScanCode.io performs deep and comprehensive
8+
scanning to meet your analysis requirements.
9+
10+
1. Install ScanCode.io
11+
----------------------
12+
13+
**Install ScanCode.io**
14+
15+
https://scancodeio.readthedocs.io/en/latest/installation.html
16+
17+
Configure ScanCode.io to identify software vulnerabilities.
18+
19+
https://scancodeio.readthedocs.io/en/latest/tutorial_vulnerablecode_integration.html#configure-vulnerablecode-integration
20+
21+
22+
2. Scan Software Using ScanCode.io
23+
----------------------------------
24+
25+
Create a new Project in ScanCode.io to scan a Docker image.
26+
27+
https://scancodeio.readthedocs.io/en/latest/tutorial_web_ui_analyze_docker_image.html
28+
29+
You now know how to use the **analyze_docker_image** pipeline!
30+
31+
3. Review Scan Results Using ScanCode.io
32+
----------------------------------------
33+
34+
https://scancodeio.readthedocs.io/en/latest/tutorial_web_ui_review_scan_results.html
35+
36+
4. Analyze a Codebase from the Command Line
37+
-------------------------------------------
38+
39+
Thinking about integrating ScanCode.io into your build system? You can scan a
40+
codebase from the command line.
41+
42+
https://scancodeio.readthedocs.io/en/latest/tutorial_cli_analyze_codebase.html
43+
44+
You now know how to use the **scan_codebase** pipeline, and you are ready to explore
45+
the many other features of ScanCode.io!
46+

0 commit comments

Comments
 (0)