Skip to content

Commit 18a3495

Browse files
authored
Update index.rst with new structure
1 parent 25cad21 commit 18a3495

1 file changed

Lines changed: 92 additions & 49 deletions

File tree

docs/index.rst

Lines changed: 92 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,105 @@
11
ScanCode.io Documentation
22
=========================
33

4-
Welcome! This is your starting point for everything ScanCode.io.
4+
ScanCode.io provides a Web UI and API to run and review complex scans in rich scripted
5+
pipelines, on different kinds of containers, docker images, package archives, manifests
6+
etc, to get information on licenses, copyrights, sources, and vulnerabilities.
57

6-
In this documentation, you’ll find:
8+
ScanCode.io provides an easy-to-use front-end to ScanCode Toolkit and other AboutCode
9+
projects.The flexible pipeline technology supports advanced scanning tasks such as
10+
container scanning and deploy-to-develop analysis. You can run ScanCode.io in a Docker
11+
container or install it on a Linux server. It provides full support for generating and
12+
consuming CycloneDX and SPDX SBOMs.
713

8-
- A **QuickStart guide** to run your first scan
9-
- An **overview** of what ScanCode.io is and what it can do
10-
- **Installation instructions** for full access
11-
- Step-by-step **tutorials** to dive deeper
12-
- In-depth **reference docs** on concepts, pipelines, configuration, and APIs
13-
- Guides on how to **contribute** to the project and community
14+
Documentation overview
15+
~~~~~~~~~~~~~~~~~~~~~~
1416

15-
.. toctree::
16-
:maxdepth: 2
17-
:caption: Getting Started
17+
The overview below outlines how the documentation is structured
18+
to help you know where to look for certain things.
1819

19-
quickstart
20-
introduction
21-
installation
22-
user-interface
23-
faq
24-
contributing
25-
changelog
20+
.. rst-class:: clearfix row
2621

27-
.. toctree::
28-
:maxdepth: 2
29-
:caption: Tutorials
30-
31-
tutorial_web_ui_analyze_docker_image
32-
tutorial_web_ui_review_scan_results
33-
tutorial_cli_analyze_docker_image
34-
tutorial_cli_analyze_codebase
35-
tutorial_api_analyze_package_archive
36-
tutorial_license_policies
37-
tutorial_vulnerablecode_integration
38-
tutorial_web_ui_symbol_and_string_collection
39-
tutorial_cli_end_to_end_scanning_to_dejacode
22+
.. rst-class:: column column2 top-left
23+
24+
:ref:`getting-started`
25+
~~~~~~~~~~~~~~~~~~~~~~
26+
27+
Start here if you are new to ScanCode.
28+
29+
- :ref:`quickstart`
30+
31+
- :ref:`introduction`
32+
- :ref:`installation`
33+
- :ref:`user-interface`
34+
35+
- :ref:`faq`
36+
37+
.. rst-class:: column column2 top-right
38+
39+
:ref:`tutorials`
40+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41+
42+
Learn via practical step-by-step guides.
43+
44+
- :ref:`tutorial_web_ui_analyze_docker_image`
45+
- :ref:`tutorial_web_ui_review_scan_result`
46+
- :ref:`tutorial_cli_analyze_docker_image`
47+
- :ref:`tutorial_api_analyze_package_archive`
48+
- :ref:`tutorial_license_policies`
49+
- :ref:`tutorial_vulnerablecode_integration`
50+
- :ref:`tutorial_web_ui_symbol_and_string_collection`
51+
- :ref:`tutorial_cli_end_to_end_scanning_to_dejacode`
52+
53+
.. rst-class:: column column2 bottom-left
54+
55+
:ref:`how-to-guides`
56+
~~~~~~~~~~~~~~~~~~~~
57+
58+
Helps you accomplish things.
59+
60+
- :ref:`contributing`
61+
62+
.. rst-class:: column column2 bottom-right
63+
64+
:ref:`reference` and :ref:`explanation`
65+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
66+
67+
Consult the reference to understand ScanCode.io concepts.
68+
69+
- :ref:`scanpipe-concepts`
70+
- :ref:`built-in-pipelines`
71+
- :ref:`custom-pipelines`
72+
- :ref:`scanpipe-pipes`
73+
- :ref:`project-configuration`
74+
- :ref:`inputs`
75+
- :ref:`output-files`
76+
- :ref:`command-line-interface`
77+
- :ref:`rest-api`
78+
- :ref:`policies`
79+
- :ref:`data-models`
80+
- :ref:`automation`
81+
- :ref:`webhooks`
82+
- :ref:`application-settings`
83+
- :ref:`distros-os-images`
84+
85+
.. rst-class:: row clearfix
86+
87+
Improving Documentation
88+
~~~~~~~~~~~~~~~~~~~~~~~
89+
90+
.. include:: /rst-snippets/improve-docs.rst
4091

4192
.. toctree::
42-
:maxdepth: 2
43-
:caption: Reference
44-
45-
scanpipe-concepts
46-
built-in-pipelines
47-
custom-pipelines
48-
scanpipe-pipes
49-
project-configuration
50-
inputs
51-
output-files
52-
command-line-interface
53-
rest-api
54-
policies
55-
data-models
56-
automation
57-
webhooks
58-
application-settings
59-
distros-os-images
93+
:maxdepth: 2
94+
:hidden:
95+
96+
getting-started/index
97+
tutorials/index
98+
how-to-guides/index
99+
reference/index
100+
explanation/index
101+
102+
changelog
60103

61104
Indices and tables
62105
==================

0 commit comments

Comments
 (0)