Skip to content

Commit db142b8

Browse files
authored
Issue #27 Improve Getting Started docs
1 parent a5dd80e commit db142b8

File tree

1 file changed

+79
-3
lines changed

1 file changed

+79
-3
lines changed

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

Lines changed: 79 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,87 @@
33
Use AboutCode to create SBOMs for your products
44
===============================================
55

6-
Intro ...
7-
**work-in-progress**
6+
You can use **ScanCode.io** to create SBOMs for your products. ScanCode.io will
7+
identify all the licenses associated with your codebase resources, highlighting the ones
8+
that need attention based on your policies. You can also use ScanCode.io to identify
9+
software vulnerabilities.
10+
11+
You can also use **DejaCode** to create SBOMs for your products. Dejacode will enable
12+
you to review your product inventories, assert license conclusions, and record your
13+
analysis and actions related to any licenses that require attention. You can also
14+
record your analysis and actions related to any software vulnerabilities that you
15+
have discovered.
816

917
1. Install AboutCode Projects
1018
-----------------------------
1119

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

0 commit comments

Comments
 (0)