Skip to content

Commit 08630ab

Browse files
committed
Merge tutorials and how-to guides #1980
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 8311b38 commit 08630ab

28 files changed

+39
-60
lines changed

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -119,10 +119,10 @@ Other Important Documentation Pages:
119119
- A `synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_
120120
of ScanCode command line options.
121121

122-
- Tutorials on:
122+
- How-Tos on:
123123

124-
- `How to run a scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
125-
- `How to visualize scan results <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_visualize_scan_results.html>`_
124+
- `Run a scan <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_run_a_scan.html>`_
125+
- `Visualize scan results <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_visualize_scan_results.html>`_
126126

127127
- An exhaustive list of `all available options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_
128128

@@ -171,7 +171,7 @@ After ScanCode is installed successfully you can run an example scan printed on
171171

172172
scancode -clip --json-pp - samples
173173

174-
Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
174+
Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_run_a_scan.html>`_
175175
tutorial to perform a basic scan on the ``samples`` directory distributed by
176176
default with ScanCode.
177177

@@ -180,8 +180,8 @@ See more command examples::
180180
scancode --examples
181181

182182
See `How to select what will be detected in a scan
183-
<https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_set_what_will_be_detected_in_a_scan.html>`_
184-
and `How to specify the output format <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_format_scan_output.html>`_
183+
<https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_set_what_will_be_detected_in_a_scan.html>`_
184+
and `How to specify the output format <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_format_scan_output.html>`_
185185
for more information.
186186

187187
You can also refer to the `command line options synopsis
@@ -203,7 +203,7 @@ directory::
203203
./extractcode mytar.tar.bz2
204204

205205
See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html#all-extractcode-options>`_
206-
and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for details.
206+
and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/how-to-guides/how_to_extract_archives.html>`_ for details.
207207

208208

209209
Support
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
.. _how_to_run_a_scan:
22

3-
.. include:: /tutorials/how_to_run_a_scan.rst
3+
.. include:: /how-to-guides/how_to_run_a_scan.rst

docs/source/getting-started/newcomer.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,19 +115,19 @@ Use ScanCode Better
115115
All Tutorials/How-Tos
116116
^^^^^^^^^^^^^^^^^^^^^
117117

118-
The Tutorials are:
118+
The How-To's are:
119119

120120
#. :ref:`how_to_run_a_scan`
121121
#. :ref:`how_to_visualize_scan_results`
122-
#. :ref:`how_to_set_what_scan_detects`
123122
#. :ref:`how_to_extract_archives`
124123
#. :ref:`how_to_specify_output_format`
125-
#. :ref:`how_to_add_post_scan_plugin`
126-
127-
The How-To's are:
128-
124+
#. :ref:`how_to_set_what_scan_detects`
129125
#. :ref:`add_new_license_for_det`
130126
#. :ref:`add_new_license_det_rule`
127+
#. :ref:`install_new_license_plugin`
128+
#. :ref:`generate_attribution`
129+
#. :ref:`how_to_add_post_scan_plugin`
130+
131131

132132
.. _newcomer_whats_new:
133133

docs/source/how-to-guides/add_new_license.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _add_new_license_for_det:
22

3-
How To Add a New License for Detection
4-
======================================
3+
Add a New License for Detection
4+
===============================
55

66
How to add a new license for detection?
77
---------------------------------------

docs/source/how-to-guides/add_new_license_detection_rule.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _add_new_license_det_rule:
22

3-
How to Add New License Rules for Enhanced Detection
4-
===================================================
3+
Add New License Rules for Enhanced Detection
4+
============================================
55

66
ScanCode relies on license rules to detect licenses. A rule is a simple text
77
file containing a license text or notice or mention with YAML frontmatter with data

0 commit comments

Comments
 (0)