Updated docs with latest information

Signed-off-by: Omkar Phansopkar <omkarphansopkar@gmail.com>

README.md

@@ -23,8 +23,8 @@ works on Windows, OS X and Linux operating systems.
 * You can [download the latest release](https://github.com/nexB/scancode-workbench/releases) 
 for your operating system or build it yourself (see below). Once downloaded, you 
 can find `ScanCode-Workbench` under `dist/ScanCode-Workbench-<os>-<arch>-<version>`
-* ScanCode Workbench >= v2 is only compatible with scans from 
-[ScanCode v2.0.0](https://github.com/nexB/scancode-toolkit/releases) and 
+* ScanCode Workbench >= v4 is only compatible with scans from 
+[ScanCode v32.0.0](https://github.com/nexB/scancode-toolkit/releases) and 
 above which are run with the ScanCode `-i` option. For a list of available ScanCode 
 options see [How To: Set what will be detected in a scan](https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_set_what_will_be_detected_in_a_scan.html)
 

docs/requirements.txt

@@ -1,6 +1,7 @@
-Sphinx>=5.0.2
-sphinx-rtd-theme>=1.0.0
-sphinx-reredirects >= 0.1.2
-doc8>=0.11.2
-jinja2==2.11.3
-markupSafe==1.1.1
+Sphinx>=7.0.0
+sphinx-autobuild
+sphinx-rtd-theme
+sphinx-reredirects
+doc8
+jinja2
+markupSafe

docs/source/contribute/building.rst

@@ -29,41 +29,50 @@ Building Requirements
 Linux
 -----
 
-- Python 3.7
-- `Node.js version <https://nodejs.org/en/download/package-manager/>`_ 6.x or later
-- npm 3.10.x or later but <= 5.2.0 (run ``npm install npm@5.2.0 -g``)
+- Python 3.7 or later
+- `Node.js <https://nodejs.org/en/download/package-manager/>`_ 12.x or later
+- npm 6.14.x or later
+- For CentOS (or linux distros without the new libstdc++) -
+
+   -  Install the new libstdc++ library: ``yum provides libstdc++``.
+   -  Update LD_LIBRARY_PATH:
+
+      ``export LD_LIBRARY_PATH="/usr/local/lib64/:$LD_LIBRARY_PATH"``
+   -  Run the application with ``no-sandbox`` option:
+
+      ``./ScanCode\ Workbench-linux-x64/ScanCode\ Workbench --no-sandbox``
 
 MacOS
 -----
 
-- Python 3.7
-- `Node.js <https://nodejs.org/en/>`_ >=6.x or later but <=8.9.4
-- npm 3.10.x or later but <= 5.2.0 (run ``npm install npm@5.2.0 -g``)
+- Python 3.7 or later
+- `Node.js <https://nodejs.org/en/>`_ 12.x or later
+- npm 6.14.x or later
 - Command Line Tools for `Xcode <https://developer.apple.com/xcode/downloads/>`_
   (run ``xcode-select --install`` to install)
 
 Windows
 -------
 
-- `Node.js <https://nodejs.org/en/>`_ 6.x or later
-- npm 3.10.x or later but <= 5.2.0 (``run npm install npm@5.2.0 -g``)
-- Python v3.7.x
+- Python v3.7 or later
+- `Node.js <https://nodejs.org/en/>`_ 12.x or later
+- npm 6.14.x or later
 
   * Make sure your Python path is set. To verify, open a command prompt and type
     ``python --version``. Then, the version of python will be displayed.
 
 Release Instructions
 ====================
 
-You can build a ``dist`` directory containing executables for any one of three target platforms
+You can build a ``dist`` directory and a ``tar/zip`` file containing executable for your platform
 by running:
 
 .. code-block:: none
 
-   $ python build.py
+   $ npm run publish
 
 After building is done, you can find ScanCode-Workbench under
-``dist/ScanCode-Workbench-<os>-x64-<version>``. Archives (``tar.gz`` and ``.zip``)
+``dist/ScanCode-Workbench-<os>-<arch>-<version>``. Archives (``tar.gz`` and ``.zip``)
 are also built.
 
 .. Note:: A build for any of the three target platforms must be executed on the targeted platform.

docs/source/contribute/community-channels.rst

@@ -5,5 +5,3 @@
 If you have a question, a suggestion or find a bug, `enter an issue <https://github.com/nexB/scancode-workbench/issues>`__.
 
 For questions and chats, you can join the Gitter channel at https://gitter.im/aboutcode-org/discuss
-
-:guilabel:`[more to come]`

docs/source/contribute/contributing-code.rst

@@ -2,4 +2,8 @@
 :index:`Contributing Code`
 ==========================
 
-:guilabel:`[to come]`
+- Contributions comes as bugs/questions/issues and as pull requests.
+- Source code and runtime data are in the ``src/`` directory.
+- Test code and test data are in the ``tests/`` directory.
+- We use DCO signoff in commit messages, like Linux does.
+

docs/source/contribute/index.rst

@@ -4,8 +4,6 @@
 :index:`Contribute`
 ===================
 
-:guilabel:`[Intro to come.]`
-
 .. toctree::
    :maxdepth: 3
 

docs/source/contribute/reporting-issues.rst

@@ -3,3 +3,5 @@
 =========================
 
 If you want to report an issue in case you find a bug or want to suggest a new feature, `report here <https://github.com/nexB/scancode-workbench/issues>`__.
+
+For questions and chats, you can join the Gitter channel at https://gitter.im/aboutcode-org/discuss

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

@@ -5,6 +5,7 @@
 .. toctree::
    :maxdepth: 3
 
+   navigate-tableview
+   navigate-license-explorer
+   navigate-package-explorer
    navigate-chart-summary-view
-
-:guilabel:`[to come]`

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

@@ -2,24 +2,20 @@
 :index:`How-To: Navigate the Chart Summary View`
 ================================================
 
-Display the view
+Display the Chart Summary view
 ================
 
 Once you have a SQLite file loaded into ScanCode Workbench, displaying the Chart
 Summary View is easy:
 
-#. Select a file or directory in the Tree View on the left.
-#. Click the chart icon in the sidebar or open the :kbd:`View` menu and select
-   :kbd:`Chart Summary View` (keyboard shortcut: :kbd:`Ctrl+Shift+D` or
-   :kbd:`⌘+Shift+D`).
+* Select a file or directory in the Tree View on the left.
+* Click on `Chart Summary View` in the sidebar or open the :kbd:`View` menu and select :kbd:`Chart Summary View` (keyboard shortcut: :kbd:`Ctrl+Shift+D` or :kbd:`⌘+Shift+D`).
 
 Select an attribute
 ===================
 
-.. figure:: data/scancode-workbench-chart-summary.gif
-
 Use the dropdown at the top of the view to select the attribute you want to
-examine (e.g., ``Copyright Statements``, ``License Key``).  These attribute values
+examine (e.g., ``Copyright Statements``, ``Detected License expression``).  These attribute values
 are detected from ScanCode, and can also be viewed in the Table View.
 
 When you select an attribute, the Chart Summary View will automatically refresh
@@ -29,11 +25,15 @@ number of times it occurs in the codebase.  You can also see the value for a
 particular entry in the bar chart in a tooltip that appears when you move your
 cursor over the text on the left or the bar on the right.
 
+.. figure:: data/chart-summary-attribute.gif
+
 Filter Chart Summary
 ====================
 
-.. figure:: data/scancode-workbench-chart-summary-filter.gif
-
 You can further filter the summary results by choosing a specific directory or
 file in the Tree View. The chart will then only show results for that selected
 directory or file.
+
+.. figure:: data/chart-summary-filetree.gif
+
+For entire UI reference, Read :ref:`chart-summary-view` 

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

@@ -0,0 +1,34 @@
+================================================
+:index:`How-To: Navigate the License Explorer View`
+================================================
+
+Display the License Explorer view
+================
+
+Once you have a SQLite file loaded into ScanCode Workbench,
+
+* Click on `License Explorer` in the sidebar or open the :kbd:`View` menu and select :kbd:`License Explorer`
+
+Select a License
+=========================
+
+On the left pane, Licenses are shown in two categories: `License Detections` & `License clues`. You can select any of these licenses & more detailed information about that license will be reflected on the right
+
+.. figure:: data/license-explorer-select.gif
+
+Search Licenses
+====================
+
+You can search for any license detecttion / clue by typing in the search box on the top-left
+
+.. figure:: data/license-explorer-search.gif
+
+Matches & File regions table
+====================
+
+For the selected license, you can view the matches resulting into the detection and the file regions where the license was detected.
+You can click on the data file path to view that path in Tableview
+
+.. figure:: data/license-explorer-table.gif
+
+For entire UI reference, Read :ref:`license-explorer` 

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

@@ -0,0 +1,44 @@
+================================================
+:index:`How-To: Navigate the Package Explorer View`
+================================================
+
+Display the Package Explorer view
+================
+
+Once you have a SQLite file loaded into ScanCode Workbench,
+
+* Click on `Package Explorer` in the sidebar or open the :kbd:`View` menu and select :kbd:`Package Explorer`
+
+Select a Package or Dependency
+=========================
+
+On the left pane, Packages are shown in a hierarchical manner as `Package Type` > `Package` > `Dependencies`
+Upon selecting a Package / Dependency, details of the entire entity is shown on the right.
+
+For a Package, information like `PURL, namespace, Declared license expression, Dependencies table, etc` are shown.
+
+For a Dependency, information like `Scope, Data file, Data source ID, etc` are shown.
+
+.. figure:: data/package-explorer-select.gif
+
+
+Filters
+====================
+
+You can filter the packages / dependencies by their data sources and/or dependency flags by selecting filter values in the top-left
+
+.. figure:: data/package-explorer-filter.gif
+
+Dependencies table
+====================
+
+When a package is selected, the dependencies for that package are shown in a table in the details pane showing Dependency information like `PURL, Scope, Data source ID, etc`
+
+You can sort the table as per convenience.
+
+You can click on the :kbd:`Data file path` to see that file in the TableView
+
+.. figure:: data/package-explorer-deps.gif
+
+
+For entire UI reference, Read :ref:`package-explorer` 

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

@@ -0,0 +1,30 @@
+================================================
+:index:`How-To: Navigate the Table View`
+================================================
+
+Display the Table view
+================
+
+Once you have a SQLite file loaded into ScanCode Workbench, you're automatically redirected to the Tableview.
+To navigate to Tableview from other views you can click on `Table View` in the sidebar or open the :kbd:`View` menu and select :kbd:`Table View`
+
+* Click on `Package Explorer` in the sidebar or open the :kbd:`View` menu and select :kbd:`Table View`
+
+
+Select a path
+===================
+
+You can collapse/expand the FileTree on the left and select a file/directory. Only the files under this path will be visible in the tableview
+
+.. figure:: data/tableview-path.gif
+
+
+Select Preset columns
+====================
+
+You can select one of the available column groups, grouped based on their nature such as ``Copyright Cols``, ``Origin Cols``, ``License Cols``
+
+.. figure:: data/tableview-column-groups.gif
+
+
+For entire UI reference, Read :ref:`table-view` 

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

@@ -16,8 +16,7 @@ a ``-clipeu`` scan of ``e2fsprogs-1.45.6.tar.gz``.
    :maxdepth: 3
 
    load-your-data/index
-   lookup-scan-version/index
+   lookup-scan-info/index
    explore-your-data/index
-   export-json-records/index
    troubleshooting/index
    special-topics/index

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

@@ -4,26 +4,34 @@
 
 To import a ScanCode JSON file:
 
+We've provided a set of sample scans that you can quickly review in ScanCode Workbench in order
+to get a sense of its functionality and the types of information captured by a scan.  The samples
+are located at `https://github.com/nexB/scancode-workbench/tree/develop/samples <https://github.com/nexB/scancode-workbench/tree/develop/samples>`_.
+
+
 * Open the :kbd:`File` menu and select :kbd:`Import JSON File` (keyboard shortcut:
   :kbd:`Ctrl+I` or :kbd:`⌘+I`).
 
   .. figure:: data/import-json-cropped.png
      :class: with-border
-     :width: 600px
+     :width: 300px
 
      ..
 
-     Import a JSON scan file.
+     Click Import a JSON scan file.
+
+     Or
+     Simply click on the Import ScanCode JSON button
 
 * In the dialog window that opens, navigate to the JSON file you want to import, select the
   file and click :kbd:`Open`.
 * You will then be prompted to choose a filename and location to save the JSON file as a SQLite
   database file.  Add a filename, select the folder in which you want to save the SQLite database
   file, and click :kbd:`Save`.
 * ScanCode Workbench will then create a SQLite database file from your JSON file, indicated by
-  the status message ``Creating Database ...``
+  the status message ``Processing scan - <Progress percentage>``
 
-  .. figure:: data/creating-database.png
+  .. figure:: data/processing-scan.png
      :class: with-border
      :width: 600px
 
@@ -35,14 +43,10 @@ To import a ScanCode JSON file:
   (the **Directory Tree**) and, to the right of the tree, a table (the **Table View**) displaying
   provenance information generated by ScanCode.
 
-  .. figure:: data/initial_load.png
+  .. figure:: data/initial-load.png
      :class: with-border
      :width: 600px
 
      ..
 
      The SQLite version of your JSON scan is ready for your analysis.
-
-We've provided a set of sample scans that you can quickly review in ScanCode Workbench in order
-to get a sense of its functionality and the types of information captured by a scan.  The samples
-are located at `https://github.com/nexB/scancode-workbench/tree/develop/samples <https://github.com/nexB/scancode-workbench/tree/develop/samples>`_.