Skip to content

Commit ccf2344

Browse files
committed
docs: add persona audit, sitemap proposal, and user journeys (closes #<issue-number>)
Signed-off-by: Zeba Fatma Khan <khanz@rknec.edu>
1 parent 18c859f commit ccf2344

File tree

3 files changed

+2593
-0
lines changed

3 files changed

+2593
-0
lines changed
Lines changed: 291 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,291 @@
1+
.. _aboutcode_home:
2+
3+
#########
4+
AboutCode
5+
#########
6+
7+
Welcome to AboutCode! We provide free and open source tools to help you understand
8+
what's in your software: where it comes from, what licenses apply, and whether it
9+
has known security issues. Whether you're managing legal compliance, securing your
10+
supply chain, or building software, AboutCode has tools to help.
11+
12+
13+
.. _who_are_you:
14+
15+
*************
16+
Who are you?
17+
*************
18+
19+
Choose your path to get started quickly with the tools and guides most relevant to you.
20+
21+
.. grid:: 1 2 3 3
22+
:gutter: 3
23+
:padding: 2
24+
25+
.. grid-item-card:: 👔 Compliance Officer
26+
:link: legal/getting-started
27+
:link-type: doc
28+
:class-card: sd-text-center sd-font-weight-bold
29+
:class-title: sd-fs-5
30+
:shadow: md
31+
32+
Manage open source licenses, create SBOMs, and ensure your organization
33+
meets its legal obligations.
34+
35+
**Get Started →**
36+
37+
+++
38+
License scanning • Policy enforcement • Attribution • SBOM generation
39+
40+
.. grid-item-card:: 🔒 Security Researcher
41+
:link: security/getting-started
42+
:link-type: doc
43+
:class-card: sd-text-center sd-font-weight-bold
44+
:class-title: sd-fs-5
45+
:shadow: md
46+
47+
Find vulnerabilities in your dependencies, analyze software composition,
48+
and secure your supply chain.
49+
50+
**Get Started →**
51+
52+
+++
53+
Vulnerability scanning • SBOM analysis • Dependency tracking • Risk assessment
54+
55+
.. grid-item-card:: 💻 Developer/Integrator
56+
:link: developer/getting-started
57+
:link-type: doc
58+
:class-card: sd-text-center sd-font-weight-bold
59+
:class-title: sd-fs-5
60+
:shadow: md
61+
62+
Integrate AboutCode tools into your build pipeline, automate scans,
63+
and use our APIs.
64+
65+
**Get Started →**
66+
67+
+++
68+
CLI tools • CI/CD integration • REST APIs • Custom pipelines
69+
70+
71+
----
72+
73+
.. _quick_links:
74+
75+
************
76+
Quick Links
77+
************
78+
79+
Not sure where to start? Here are some popular tasks:
80+
81+
.. grid:: 1 2 2 2
82+
:gutter: 2
83+
84+
.. grid-item-card:: 📋 Create an SBOM
85+
:link: getting-started/create-sboms
86+
:link-type: doc
87+
88+
Generate Software Bill of Materials in SPDX or CycloneDX format
89+
90+
.. grid-item-card:: 🔍 Scan for Licenses
91+
:link: getting-started/start-scanning-code
92+
:link-type: doc
93+
94+
Identify licenses and copyrights in your codebase
95+
96+
.. grid-item-card:: 🛡️ Find Vulnerabilities
97+
:link: security/quickstart/first-vulnerability-scan
98+
:link-type: doc
99+
100+
Discover known security issues in your dependencies
101+
102+
.. grid-item-card:: ⚖️ Set License Policies
103+
:link: getting-started/manage-license-policies
104+
:link-type: doc
105+
106+
Define which licenses are approved for your organization
107+
108+
109+
----
110+
111+
.. _aboutcode_projects:
112+
113+
******************
114+
AboutCode Projects
115+
******************
116+
117+
AboutCode is a family of tools that work together:
118+
119+
.. grid:: 1 1 2 2
120+
:gutter: 3
121+
122+
.. grid-item-card:: ScanCode.io
123+
:link: aboutcode-projects/scancodeio-project
124+
:link-type: doc
125+
:img-top: _static/images/scancodeio-icon.svg
126+
:img-alt: ScanCode.io
127+
128+
Automated pipeline platform for scanning packages, containers, and codebases
129+
at scale.
130+
131+
.. grid-item-card:: ScanCode Toolkit
132+
:link: aboutcode-projects/scancode-toolkit-project
133+
:link-type: doc
134+
:img-top: _static/images/scancode-icon.svg
135+
:img-alt: ScanCode Toolkit
136+
137+
Command-line tool to detect licenses, copyrights, and dependencies in your code.
138+
139+
.. grid-item-card:: VulnerableCode
140+
:link: aboutcode-projects/vulnerablecode-project
141+
:link-type: doc
142+
:img-top: _static/images/vulnerablecode-icon.svg
143+
:img-alt: VulnerableCode
144+
145+
Open database of software vulnerabilities with tools to track and correlate CVEs.
146+
147+
.. grid-item-card:: DejaCode
148+
:link: aboutcode-projects/dejacode-project
149+
:link-type: doc
150+
:img-top: _static/images/dejacode-icon.svg
151+
:img-alt: DejaCode
152+
153+
Enterprise compliance platform for managing software inventories and policies.
154+
155+
.. grid-item-card:: PurlDB
156+
:link: aboutcode-projects/purldb-project
157+
:link-type: doc
158+
:img-top: _static/images/purldb-icon.svg
159+
:img-alt: PurlDB
160+
161+
Database of Package URLs (PURLs) with package metadata and matching capabilities.
162+
163+
.. grid-item-card:: ScanCode Workbench
164+
:link: aboutcode-projects/scancode-workbench-project
165+
:link-type: doc
166+
:img-top: _static/images/workbench-icon.svg
167+
:img-alt: ScanCode Workbench
168+
169+
Desktop application to review scan results and document your conclusions.
170+
171+
.. button-link:: aboutcode-project-overview.html
172+
:color: primary
173+
:outline:
174+
175+
View All Projects
176+
177+
178+
----
179+
180+
.. _explore_documentation:
181+
182+
*********************
183+
Explore Documentation
184+
*********************
185+
186+
.. toctree::
187+
:maxdepth: 1
188+
:caption: By Role
189+
190+
legal/index
191+
security/index
192+
developer/index
193+
194+
.. toctree::
195+
:maxdepth: 2
196+
:caption: Getting Started
197+
198+
getting-started/start-scanning-code
199+
getting-started/create-sboms
200+
getting-started/consume-sboms
201+
getting-started/manage-license-policies
202+
getting-started/cra-compliance
203+
204+
.. toctree::
205+
:maxdepth: 2
206+
:caption: All Projects
207+
208+
aboutcode-project-overview
209+
aboutcode-projects/scancodeio-project
210+
aboutcode-projects/scancode-toolkit-project
211+
aboutcode-projects/vulnerablecode-project
212+
aboutcode-projects/dejacode-project
213+
aboutcode-projects/purldb-project
214+
aboutcode-projects/scancode-workbench-project
215+
aboutcode-projects/license-expression-project
216+
aboutcode-projects/scancode-licensedb-project
217+
aboutcode-projects/source-inspector-project
218+
aboutcode-projects/python-inspector-project
219+
aboutcode-projects/scancode-action-project
220+
aboutcode-projects/aboutcode-toolkit-project
221+
222+
.. toctree::
223+
:maxdepth: 2
224+
:caption: Data & Standards
225+
226+
aboutcode-data/abcd
227+
228+
.. toctree::
229+
:maxdepth: 2
230+
:caption: Contributing
231+
232+
contributing
233+
234+
.. toctree::
235+
:maxdepth: 1
236+
:caption: Community & Archive
237+
238+
archive
239+
license
240+
241+
242+
----
243+
244+
.. _need_help:
245+
246+
*********
247+
Need Help?
248+
*********
249+
250+
.. grid:: 1 2 2 2
251+
:gutter: 2
252+
253+
.. grid-item::
254+
:columns: 12 6 6 6
255+
256+
**💬 Chat with Us**
257+
258+
Join our community on `Gitter <https://gitter.im/aboutcode-org/discuss>`_
259+
or `Slack <https://join.slack.com/t/aboutcode-org/shared_invite/zt-1paqwxccw-IuafuiAvYJFkTqGaZsC1og>`_
260+
261+
.. grid-item::
262+
:columns: 12 6 6 6
263+
264+
**🐛 Report Issues**
265+
266+
Found a bug? `Open an issue <https://github.com/aboutcode-org/>`_ on
267+
the relevant project repository
268+
269+
.. grid-item::
270+
:columns: 12 6 6 6
271+
272+
**📚 Browse Code**
273+
274+
Explore our projects at `github.com/aboutcode-org <https://github.com/aboutcode-org/>`_
275+
276+
.. grid-item::
277+
:columns: 12 6 6 6
278+
279+
**🎓 Learn More**
280+
281+
Visit `AboutCode.org <https://www.aboutcode.org/>`_ for news, events,
282+
and community resources
283+
284+
285+
.. note::
286+
**New to Software Composition Analysis?**
287+
288+
Software Composition Analysis (SCA) helps you understand what open source
289+
components are in your software, their licenses, and any security vulnerabilities.
290+
Think of it as creating a detailed ingredient list for your software, so you
291+
can make informed decisions about what you use and how you use it.

0 commit comments

Comments
 (0)