Skip to content

Commit de02680

Browse files
DennisClarkDennisClark
authored
Create new getting-started docs
1 parent 8934cf9 commit de02680

7 files changed

Lines changed: 172 additions & 0 deletions

File tree

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _consume-sboms:
2+
3+
Use AboutCode to consume SBOMs from your suppliers
4+
==================================================
5+
6+
Intro ...
7+
**work-in-progress**
8+
9+
1. Install AboutCode Projects
10+
-----------------------------
11+
12+
**work-in-progress**
13+

‎docs/source/getting-started/cra-compliance.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _cra-compliance:
2+
3+
Use AboutCode to support CRA compliance
4+
=======================================
5+
6+
Intro ...
7+
**work-in-progress**
8+
9+
1. Install AboutCode Projects
10+
-----------------------------
11+
12+
**work-in-progress**
13+

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _create-sboms:
2+
3+
Use AboutCode to create SBOMs for your products
4+
===============================================
5+
6+
Intro ...
7+
**work-in-progress**
8+
9+
1. Install AboutCode Projects
10+
-----------------------------
11+
12+
**work-in-progress**
13+

‎docs/source/getting-started/find-security-vulnerabilities.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
.. _find-security-vulnerabilities:
2+
3+
Use AboutCode to find security vulnerabilities
4+
==============================================
5+
6+
Intro ...
7+
**work-in-progress**
8+
9+
1. Install AboutCode Projects
10+
-----------------------------
11+
12+
**work-in-progress**
13+
14+

‎docs/source/getting-started/license-compliance.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
.. _license-compliance:
2+
3+
Use AboutCode to ensure license compliance in your products
4+
===========================================================
5+
6+
Intro ...
7+
8+
1. Install AboutCode Projects
9+
-----------------------------
10+
11+
**Install DejaCode.**
12+
13+
https://dejacode.readthedocs.io/en/latest/installation.html
14+
15+
**Setup your own Dataspace in DejaCode**
16+
17+
https://dejacode.readthedocs.io/en/latest/dataspace.html
18+
19+
Not ready to install your own instance of DejaCode? Consider taking a look at
20+
the DejaCode public evaluation site to take a test drive, and if you have specific
21+
requirements, you may also request a private SaaS evaluation dataspace.
22+
See https://public.dejacode.com/account/register/
23+
24+
**Install ScanCode.io**
25+
26+
https://scancodeio.readthedocs.io/en/latest/installation.html
27+
28+
Configure DejaCode to integrate with ScanCode.io. See
29+
30+
https://dejacode.readthedocs.io/en/latest/application-settings.html#scancodeio
31+
32+
**Install PurlDB**
33+
34+
https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/getting-started/install.html
35+
36+
Configure DejaCode to integrate with your PurlDB instance. See:
37+
38+
https://dejacode.readthedocs.io/en/latest/application-settings.html#purldb
39+
40+
Not ready to install your own instance of PurlDB? You can configure DejaCode to
41+
integrate with the public version at https://public.vulnerablecode.io/
42+
43+
2. Setup your Usage Policies
44+
----------------------------
45+
46+
See https://aboutcode.readthedocs.io/en/latest/aboutcode-projects/manage-usage-policies.html
47+
48+
3.
49+
50+
51+
52+
53+
54+

‎docs/source/getting-started/manage-license-policies.rst‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
.. _manage-license-policies:
2+
3+
Use AboutCode to manage and communicate license policies
4+
========================================================
5+
6+
You can define the Usage Policy choices that may apply to various application object
7+
types such as Licenses, Components, Subcomponent relationships, and Packages.
8+
For each application object type, you can specify the Usage Policy label text, icon,
9+
and icon color for each relevant policy position that you need to communicate to your
10+
users. Examples include Recommended, Approved, Restricted, and Prohibited.
11+
12+
1. Install AboutCode Projects
13+
-----------------------------
14+
15+
**Install DejaCode.**
16+
17+
https://dejacode.readthedocs.io/en/latest/installation.html
18+
19+
**Setup your own Dataspace in DejaCode**
20+
21+
https://dejacode.readthedocs.io/en/latest/dataspace.html
22+
23+
Not ready to install your own instance of DejaCode? Consider taking a look at
24+
the DejaCode public evaluation site to take a test drive, and if you have specific
25+
requirements, you may also request a private SaaS evaluation dataspace.
26+
See https://public.dejacode.com/account/register/
27+
28+
2. Create Your Usage Policies
29+
-----------------------------
30+
31+
You can copy the Reference data usage policies to your dataspace for a quick start.
32+
Modify them to fit your specific requirements.
33+
34+
For details, see https://dejacode.readthedocs.io/en/latest/howto-1.html
35+
36+
Assign your usage policies to licenses. For details, see
37+
https://dejacode.readthedocs.io/en/latest/howto-1.html#assign-your-usage-policies-to-licenses
38+
39+
Make your usage policies visible to DejaCode users. For details, see
40+
https://dejacode.readthedocs.io/en/latest/howto-1.html#make-usage-policies-visible-to-your-users
41+
42+
3. Export Your Usage Policies
43+
-----------------------------
44+
45+
To use your Usage Policies in **ScanCode Toolkit** and **ScanCode.io** see
46+
47+
https://dejacode.readthedocs.io/en/latest/howto-1.html#export-license-policy-definitions
48+
49+
https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/list-options.html#all-post-scan-options
50+
51+
https://scancodeio.readthedocs.io/en/latest/tutorial_license_policies.html#license-policies-and-compliance-alerts
52+

‎docs/source/getting-started/security-remediation.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _security-remediation:
2+
3+
Use AboutCode to manage security remediation tasks
4+
==================================================
5+
6+
Intro ...
7+
**work-in-progress**
8+
9+
1. Install AboutCode Projects
10+
-----------------------------
11+
12+
**work-in-progress**
13+

0 commit comments

Comments
 (0)