-
-
Notifications
You must be signed in to change notification settings - Fork 167
Improve docs for Getting Started purposes #202
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
DennisClark
wants to merge
22
commits into
main
Choose a base branch
from
improve-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
f89816b
Update aboutcode-project-overview.rst
DennisClark e0d08fd
Add DejaCode and PurlDB to project list
DennisClark 8934cf9
Create getting-started/temp.rst
DennisClark de02680
Create new getting-started docs
DennisClark 1aa4111
Issue #27 Improve Getting Started docs
DennisClark d711bbe
Issue #27 Improve Getting Started docs
DennisClark a5dd80e
Issue #27 Improve Getting Started docs
DennisClark db142b8
Issue #27 Improve Getting Started docs
DennisClark d2c0064
Issue #27 Improve Getting Started docs
DennisClark bf95d80
Issue #27 this file deprecated
DennisClark 130403e
Issue #27 this file deprecated
DennisClark 4d08023
Issue #27 this file deprecated
DennisClark a1b8731
Issue #27 this file deprecated
DennisClark 141fb92
Issue #27 Refinements to Getting Started docs
DennisClark 99fd1fb
Issue #27 remove unused files
DennisClark 950f67b
Issue #27 minor improvement to text
DennisClark d28ae46
Issue #27 some reorganizing of the project list
DennisClark 52e950b
Merge branch 'main' into improve-docs
DennisClark 3392ba3
Issue #27 Correct formatting problems in two docs
DennisClark faf767b
Issue #27 Introduce start-scanning-code and additional projects
DennisClark add5569
Issue #27 respond to suggestions in PR #202
DennisClark 13262f8
Issue #27. Identify additional supporting AboutCode projects.
DennisClark File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
.. _dejacode-project: | ||
|
||
DejaCode | ||
======== | ||
|
||
`DejaCode <https://github.com/aboutcode-org/dejacode>`_: is a Cloud | ||
application server that automates open source license compliance and ensures | ||
software supply chain integrity. It is a comprehensive enterprise-level application, | ||
powered by `ScanCode <https://github.com/aboutcode-org/scancode-toolkit>`_, | ||
the industry-leading code scanner. | ||
|
||
* Run scans and track all the open source and third-party products and | ||
components used in your software. | ||
* Apply usage policies at the license or component level, | ||
integrate into ScanCode to ensure compliance. | ||
* Capture software inventories (SBOMs), generate compliance artifacts, and keep | ||
historical data. | ||
* Ensure FOSS compliance with enterprise-grade features and integrations for DevOps | ||
and software systems. | ||
* Scan a software package, simply by providing its Download URL, to get comprehensive | ||
details of its composition and create an SBOM. | ||
* Load software package data into DejaCode with the integration for the open source | ||
ScanCode.io and ScanCode Toolkit projects to create a product’s SBOM. | ||
* Track and report vulnerability tracking and reporting by integrating with the open | ||
source VulnerableCode project. | ||
* Create, publish and share SBOM documents in DejaCode, including detailed attribution | ||
documentation and custom reports in multiple file formats and standards, such as | ||
CycloneDX and SPDX. | ||
|
||
Read more at: https://dejacode.readthedocs.io | ||
|
||
Get the code at: https://github.com/aboutcode-org/dejacode | ||
|
11 changes: 11 additions & 0 deletions
11
docs/source/aboutcode-projects/license-expression-project.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.. _license-expression-project: | ||
|
||
license-expression | ||
================== | ||
|
||
`license-expression <https://github.com/aboutcode-org/license-expression>`_: is a | ||
comprehensive utility library to parse, compare, simplify and normalize license | ||
expressions (such as SPDX license expressions) using boolean logic. | ||
|
||
- Read more at: https://github.com/aboutcode-org/license-expression | ||
- Get the code at: https://github.com/aboutcode-org/license-expression/releases |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
.. purldb-project: | ||
|
||
PurlDB | ||
====== | ||
|
||
`PurlDB <https://github.com/aboutcode-org/purldb>`_: is a set of | ||
tools to create and expose a database of purls (Package URLs). This project is | ||
sponsored by NLnet project https://nlnet.nl/project/vulnerabilitydatabase/ and | ||
nexB for https://www.aboutcode.org/ | ||
|
||
The PurlDB tools include: | ||
|
||
* PackageDB that is the reference model (based on ScanCode toolkit) that contains | ||
package data with PURL (Package URLs) being a first class citizen. | ||
* MineCode that contains utilities to mine package repositories | ||
* MatchCode that contains utilities to index package metadata and resources for | ||
matching | ||
* MatchCode.io that provides package matching functionalities for codebases | ||
* ClearCode that contains utilities to mine Clearlydefined for package data | ||
* purldb-toolkit CLI utility and library to use the PurlDB, its API and various | ||
related libraries. | ||
|
||
Read more at: https://purldb.readthedocs.io | ||
|
||
Get the code at: https://github.com/aboutcode-org/purldb | ||
|
27 changes: 27 additions & 0 deletions
27
docs/source/aboutcode-projects/python-inspector-project.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
.. _python-inspector-project: | ||
|
||
python-inspector | ||
================ | ||
|
||
`python-inspector <https://github.com/aboutcode-org/python-inspector>`_: | ||
is a collection of utilities to: | ||
|
||
- resolve PyPI packages dependencies | ||
|
||
- parse various requirements.txt files and setup.py files as input | ||
for resolving dependencies. | ||
|
||
- parse various manifests and packages files such as | ||
Pipfile, pyproject.toml, poetry.lock and setup.cfg and legacy and | ||
current metadata file formats for eggs, wheels and sdist. These | ||
have not been wired with the command line yet. | ||
|
||
- query PyPI JSON and simple APIs for package information | ||
|
||
It grew out of ScanCode-Toolkit to find and analyze PyPI archives and | ||
installed Python packages and their files. | ||
|
||
The goal of python-inspector is to be a comprehensive library | ||
that can handle every style of Python package layouts, manifests and lockfiles. | ||
|
||
- Get the code at: https://github.com/aboutcode-org/python-inspector |
10 changes: 10 additions & 0 deletions
10
docs/source/aboutcode-projects/scancode-action-project.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
.. _scancode-action-project: | ||
|
||
scancode-action | ||
=============== | ||
|
||
`scancode-action <https://github.com/aboutcode-org/scancode-action>`_: enables | ||
you to run ScanCode.io pipelines from your workflows. | ||
|
||
- Read more at: https://github.com/aboutcode-org/scancode-action | ||
- Get the code at: https://github.com/aboutcode-org/scancode-action/releases |
27 changes: 27 additions & 0 deletions
27
docs/source/aboutcode-projects/scancode-licensedb-project.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
.. _scancode-licensedb-project: | ||
|
||
ScanCode LicenseDB | ||
================== | ||
|
||
`ScanCode LicenseDB <https://github.com/aboutcode-org/scancode-licensedb>`_: | ||
is a large free and open database of software licenses, in particular open-source | ||
software licenses, with over 2300 curated licenses texts and their metadata. | ||
|
||
LicenseDB is built from the ScanCode Toolkit license dataset. ScanCode Toolkit | ||
is a leading open source code scanner and license detection engine. | ||
|
||
LicenseDB is an essential reference license resource for license compliance and | ||
SBOMs. LicenseDB includes all the SPDX and OSI licenses together with an extended | ||
curated collection of other licenses and license metadata. These licenses are | ||
carefully reviewed and curated and continuously updated by an open community of | ||
contributors. | ||
|
||
LicenseDB is available as a web site at: https://scancode-licensedb.aboutcode.org/ | ||
You can search the licenses by name, key and other attributes. The web site is updated | ||
daily by a GitHub action with updates from scancode-toolkit develop. | ||
|
||
LicenseDB is also available as a JSON or YAML API and a git repository | ||
making it easy to reuse and integrate in tools that need a database of reference | ||
software licenses. | ||
|
||
- Get the code at: https://github.com/aboutcode-org/scancode-licensedb |
11 changes: 11 additions & 0 deletions
11
docs/source/aboutcode-projects/source-inspector-project.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.. _source-inspector-project: | ||
|
||
source-inspector | ||
================ | ||
|
||
`source-inspector <https://github.com/aboutcode-org/source-inspector>`_: | ||
is a collection of utilities to inspect and analyze source code and collect interesting | ||
data using various tools such as code symbols, strings and comments. | ||
This is also a ScanCode-Toolkit plugin. | ||
|
||
- Get the code at: https://github.com/aboutcode-org/source-inspector |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
.. _consume-sboms: | ||
|
||
Use AboutCode to consume SBOMs from your suppliers | ||
================================================== | ||
|
||
You can use **ScanCode.io** to consume SBOMs from your suppliers. ScanCode.io will | ||
identify all the licenses associated with your codebase resources, highlighting the ones | ||
that need attention based on your policies. ScanCode.io also identifies and highlights | ||
software vulnerabilities. | ||
|
||
You can also use **DejaCode** to consume SBOMs from your suppliers, generally in the | ||
DennisClark marked this conversation as resolved.
Show resolved
Hide resolved
|
||
context of an SBOM that you intend to use in one of your own products. | ||
|
||
1. Install AboutCode Projects | ||
----------------------------- | ||
|
||
**Install ScanCode.io** | ||
|
||
https://scancodeio.readthedocs.io/en/latest/installation.html | ||
|
||
**Install DejaCode.** | ||
|
||
https://dejacode.readthedocs.io/en/latest/installation.html | ||
|
||
**Setup your own Dataspace in DejaCode** | ||
|
||
https://dejacode.readthedocs.io/en/latest/dataspace.html | ||
|
||
.. note:: | ||
Not ready to install your own instance of DejaCode? Consider taking a look at | ||
the DejaCode public evaluation site to take a test drive, and if you have specific | ||
requirements, you may also request a private SaaS evaluation dataspace. | ||
See https://public.dejacode.com/account/register/ | ||
|
||
Configure DejaCode to integrate with ScanCode.io. See | ||
|
||
https://dejacode.readthedocs.io/en/latest/application-settings.html#scancodeio | ||
|
||
**Install PurlDB** | ||
|
||
https://aboutcode.readthedocs.io/projects/PURLdb/en/latest/getting-started/install.html | ||
|
||
Configure DejaCode to integrate with your PurlDB instance. See: | ||
|
||
https://dejacode.readthedocs.io/en/latest/application-settings.html#purldb | ||
|
||
.. note:: | ||
Not ready to install your own instance of PurlDB? You can configure DejaCode to | ||
integrate with the public version at https://public.purldb.io/ | ||
|
||
**Install VulnerableCode** | ||
|
||
https://vulnerablecode.readthedocs.io/en/latest/installation.html#installation | ||
|
||
Configure Dejacode to integrate with your Vulnerablecode instance. | ||
|
||
https://dejacode.readthedocs.io/en/latest/dataspace.html#enable-vulnerablecodedb-service | ||
|
||
.. note:: | ||
Not ready to install your own instance of VulnerableCode? You can configure DejaCode | ||
to integrate with the public version at https://public.vulnerablecode.io/ | ||
|
||
|
||
2. Load Package Data from SBOMs to ScanCode.io | ||
---------------------------------------------- | ||
|
||
Create a new Project in ScanCode.io . | ||
|
||
https://scancodeio.readthedocs.io/en/latest/user-interface.html#creating-a-new-project | ||
|
||
Load package data from one or more SBOMs to your Project using the load_sbom Pipeline. | ||
|
||
https://scancodeio.readthedocs.io/en/latest/built-in-pipelines.html#load-sbom | ||
|
||
Review the details in your ScanCode.io project. | ||
|
||
Export the results in the appropriate format to share with your team, such as CycloneDX | ||
and SPDX SBOMs. | ||
|
||
https://scancodeio.readthedocs.io/en/latest/output-files.html#output-files | ||
|
||
|
||
3. Import SBOM data to a DejaCode Product | ||
----------------------------------------- | ||
|
||
Create a new Product in DejaCode for comprehensive analysis and action. | ||
|
||
https://dejacode.readthedocs.io/en/latest/tutorial-1.html | ||
|
||
Load an SBOM to your Dejacode Product. | ||
|
||
https://dejacode.readthedocs.io/en/latest/tutorial-5-sboms.html#load-an-sbom-to-your-product | ||
|
||
Review and edit your Product in DejaCode. Enrich the data as needed. | ||
|
||
Generate Attribution and SBOMs from DejaCode Products. | ||
|
||
https://dejacode.readthedocs.io/en/latest/tutorial-5-sboms.html#tutorial-5-working-with-sboms-in-a-product |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
.. _cra-compliance: | ||
|
||
Use AboutCode to support CRA compliance | ||
======================================= | ||
|
||
The AboutCode stack provides you with the tools you need to support CRA Compliance | ||
activities, including code scanning and analysis, license identification, vulnerability | ||
management, and SBOM generation. | ||
|
||
https://dejacode.readthedocs.io/en/latest/reference-3-cravex.html | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.