Skip to content

Commit d711bbe

Browse files
authored
Issue #27 Improve Getting Started docs
1 parent 1aa4111 commit d711bbe

File tree

1 file changed

+87
-3
lines changed

1 file changed

+87
-3
lines changed

docs/source/getting-started/consume-sboms.rst

Lines changed: 87 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,95 @@
33
Use AboutCode to consume SBOMs from your suppliers
44
==================================================
55

6-
Intro ...
7-
**work-in-progress**
6+
You can use **ScanCode.io** to consume SBOMs from your suppliers. ScanCode.io will
7+
identify all the licenses associated with your codebase resources, highlighting the ones
8+
that need attention based on your policies. ScanCode.io also identifies and highlights
9+
software vulnerabilities.
10+
11+
You can also use **DejaCode** to consume SBOMs from your suppliers, generally in the
12+
context of an SBOM that you intend to use in one of your own products.
813

914
1. Install AboutCode Projects
1015
-----------------------------
1116

12-
**work-in-progress**
17+
**Install DejaCode.**
18+
19+
https://dejacode.readthedocs.io/en/latest/installation.html
20+
21+
**Setup your own Dataspace in DejaCode**
22+
23+
https://dejacode.readthedocs.io/en/latest/dataspace.html
24+
25+
.. note::
26+
Not ready to install your own instance of DejaCode? Consider taking a look at
27+
the DejaCode public evaluation site to take a test drive, and if you have specific
28+
requirements, you may also request a private SaaS evaluation dataspace.
29+
See https://public.dejacode.com/account/register/
30+
31+
**Install ScanCode.io**
32+
33+
https://scancodeio.readthedocs.io/en/latest/installation.html
34+
35+
Configure DejaCode to integrate with ScanCode.io. See
36+
37+
https://dejacode.readthedocs.io/en/latest/application-settings.html#scancodeio
38+
39+
**Install PurlDB**
40+
41+
https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/getting-started/install.html
42+
43+
Configure DejaCode to integrate with your PurlDB instance. See:
44+
45+
https://dejacode.readthedocs.io/en/latest/application-settings.html#purldb
46+
47+
.. note::
48+
Not ready to install your own instance of PurlDB? You can configure DejaCode to
49+
integrate with the public version at https://public.purldb.io/
50+
51+
**Install VulnerableCode**
52+
53+
https://vulnerablecode.readthedocs.io/en/latest/installation.html#installation
54+
55+
Configure Dejacode to integrate with your Vulnerablecode instance.
56+
57+
https://dejacode.readthedocs.io/en/latest/dataspace.html#enable-vulnerablecodedb-service
58+
59+
.. note::
60+
Not ready to install your own instance of VulnerableCode? You can configure DejaCode
61+
to integrate with the public version at https://public.vulnerablecode.io/
62+
63+
64+
2. Load Package Data from SBOMs to ScanCode.io
65+
----------------------------------------------
66+
67+
Create a new Project in ScanCode.io .
68+
69+
https://scancodeio.readthedocs.io/en/latest/user-interface.html#creating-a-new-project
70+
71+
Load package data from one or more SBOMs to your Project using the load_sbom Pipeline.
72+
73+
https://scancodeio.readthedocs.io/en/latest/built-in-pipelines.html#load-sbom
74+
75+
Review the details in your ScanCode.io project.
76+
77+
Export the results in the appropriate format to share with your team.
78+
79+
https://scancodeio.readthedocs.io/en/latest/output-files.html#output-files
80+
81+
82+
3. Import SBOM data to a DejaCode Product
83+
-----------------------------------------
84+
85+
Create a new Product in DejaCode for comprehensive analysis and action.
86+
87+
https://dejacode.readthedocs.io/en/latest/tutorial-1.html
88+
89+
Load an SBOM to your Dejacode Product.
90+
91+
https://dejacode.readthedocs.io/en/latest/tutorial-5-sboms.html#load-an-sbom-to-your-product
92+
93+
Review and edit your Product in DejaCode. Enrich the data as needed.
94+
95+
Generate Attribution and SBOMs from DejaCode Products.
1396

97+
https://dejacode.readthedocs.io/en/latest/tutorial-5-sboms.html#tutorial-5-working-with-sboms-in-a-product

0 commit comments

Comments
 (0)