Skip to content

Commit 8a217c8

Browse files
committed
Updated underlying technology, build tools versions, removed policies outdated docs
Signed-off-by: Omkar Phansopkar <[email protected]>
1 parent e7914f4 commit 8a217c8

File tree

14 files changed

+51
-91
lines changed

14 files changed

+51
-91
lines changed

docs/source/contribute/building.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,18 @@ Building Requirements
2929
Linux
3030
-----
3131

32-
- Python 3.7 or later
33-
- `Node.js <https://nodejs.org/en/download/package-manager/>`__ 12.x or later
34-
- npm 6.14.x or later
32+
- `Python <https://www.python.org/>`__ v3.7 or later
33+
- `Node.js <https://nodejs.org/en//>`__ 14.x or later
34+
- `npm <https://www.npmjs.com/>`__ v6.14.4 or later
3535

3636
.. include:: ../rst_snippets/centos-note.rst
3737

3838
MacOS
3939
-----
4040

41-
- Python 3.7 or later
42-
- `Node.js <https://nodejs.org/en/>`__ 12.x or later
43-
- npm 6.14.x or later
41+
- `Python <https://www.python.org/>`__ v3.7 or later
42+
- `Node.js <https://nodejs.org/en/>`__ 14.x or later
43+
- `npm <https://www.npmjs.com/>`__ v6.14.4 or later
4444
- Command Line Tools for `Xcode <https://developer.apple.com/xcode/resources/>`_
4545
Install using:
4646

@@ -51,16 +51,16 @@ MacOS
5151
Windows
5252
-------
5353

54-
- Python v3.7 or later
54+
- `Python <https://www.python.org/>`__ v3.7 or later
5555

5656
* Make sure your Python path is set. To verify, open a command prompt and see the python version:
5757

5858
.. code-block:: bash
5959
6060
python --version
6161
62-
- `Node.js <https://nodejs.org/en/>`__ 12.x or later
63-
- npm 6.14.x or later
62+
- `Node.js <https://nodejs.org/en/>`__ v14.x or later
63+
- `npm <https://www.npmjs.com/>`__ v6.14.4 or later
6464

6565

6666
Release Instructions

docs/source/how-to-guides/explore-your-data/navigate-chart-summary-view.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,5 @@ directory or file.
4040
.. figure:: data/chart-summary-filetree.gif
4141

4242
For entire UI reference, Read :ref:`chart-summary-view`
43+
44+
.. include:: ../../rst_snippets/scans-used.rst

docs/source/how-to-guides/explore-your-data/navigate-license-explorer.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,5 @@ You can click on the data file path to view that path in Tableview
3737
.. figure:: data/license-explorer-table.gif
3838

3939
For entire UI reference, Read :ref:`license-explorer`
40+
41+
.. include:: ../../rst_snippets/scans-used.rst

docs/source/how-to-guides/explore-your-data/navigate-package-explorer.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,5 @@ You can click on the :kbd:`Data file path` to see that file in the TableView
5252

5353

5454
For entire UI reference, See :ref:`package-explorer`
55+
56+
.. include:: ../../rst_snippets/scans-used.rst

docs/source/how-to-guides/explore-your-data/navigate-tableview.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,5 @@ nature such as ``Copyright Cols``, ``Origin Cols``, ``License Cols``
3232

3333

3434
For entire UI reference, Read :ref:`table-view`
35+
36+
.. include:: ../../rst_snippets/scans-used.rst

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
:index:`How-To Guides`
55
======================
66

7+
The ScanCode Workbench How-To Guides will walk you through loading and analyzing a `-clipeu` scan.
8+
The guides are not meant to be exhaustive, but rather to give you a taste of
9+
what you can do with the Workbench.
10+
11+
For full set of features, please refer to the :ref:`ui-reference`.
712

813
.. toctree::
914
:maxdepth: 3
@@ -12,4 +17,3 @@
1217
lookup-scan-info/index
1318
explore-your-data/index
1419
troubleshooting/index
15-
special-topics/index

docs/source/how-to-guides/load-your-data/import-json.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,5 @@ are located at `https://github.com/nexB/scancode-workbench/tree/develop/samples
5050
..
5151
5252
The SQLite version of your JSON scan is ready for your analysis.
53+
54+
.. include:: ../../rst_snippets/scans-used.rst

docs/source/how-to-guides/lookup-scan-info/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,5 @@ or, open the :kbd:`View` menu and select :kbd:`Scan Info`
1515
1616
You can view various details about the scan like scan tool name & version, options, platform etc.
1717
More detailed explanation about the view can be found at :ref:`scan-info`
18+
19+
.. include:: ../../rst_snippets/scans-used.rst
-285 KB
Binary file not shown.

docs/source/how-to-guides/special-topics/index.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)