Skip to content

Commit

Permalink
Updated underlying technology, build tools versions, removed policies…
Browse files Browse the repository at this point in the history
… outdated docs

Signed-off-by: Omkar Phansopkar <[email protected]>
  • Loading branch information
OmkarPh committed Oct 19, 2023
1 parent e7914f4 commit 4439789
Show file tree
Hide file tree
Showing 13 changed files with 44 additions and 85 deletions.
18 changes: 9 additions & 9 deletions docs/source/contribute/building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,18 @@ Building Requirements
Linux
-----

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

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

MacOS
-----

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

Expand All @@ -51,16 +51,16 @@ MacOS
Windows
-------

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

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

.. code-block:: bash
python --version
- `Node.js <https://nodejs.org/en/>`__ 12.x or later
- npm 6.14.x or later
- `Node.js <https://nodejs.org/en/>`__ v14.x or later
- `npm <https://www.npmjs.com/>`__ v6.14.4 or later


Release Instructions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ directory or file.
.. figure:: data/chart-summary-filetree.gif

For entire UI reference, Read :ref:`chart-summary-view`

.. include:: ../../rst_snippets/scans-used.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,5 @@ 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`

.. include:: ../../rst_snippets/scans-used.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,5 @@ You can click on the :kbd:`Data file path` to see that file in the TableView


For entire UI reference, See :ref:`package-explorer`

.. include:: ../../rst_snippets/scans-used.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ nature such as ``Copyright Cols``, ``Origin Cols``, ``License Cols``


For entire UI reference, Read :ref:`table-view`

.. include:: ../../rst_snippets/scans-used.rst
6 changes: 5 additions & 1 deletion docs/source/how-to-guides/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
:index:`How-To Guides`
======================

The ScanCode Workbench How-To Guides will walk you through loading and analyzing a `-clipeu` scan.
The guides are not meant to be exhaustive, but rather to give you a taste of
what you can do with the Workbench.

For full set of features, please refer to the :ref:`ui-reference`.

.. toctree::
:maxdepth: 3
Expand All @@ -12,4 +17,3 @@
lookup-scan-info/index
explore-your-data/index
troubleshooting/index
special-topics/index
2 changes: 2 additions & 0 deletions docs/source/how-to-guides/load-your-data/import-json.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,5 @@ are located at `https://github.com/nexB/scancode-workbench/tree/develop/samples
..
The SQLite version of your JSON scan is ready for your analysis.

.. include:: ../../rst_snippets/scans-used.rst
2 changes: 2 additions & 0 deletions docs/source/how-to-guides/lookup-scan-info/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@ or, open the :kbd:`View` menu and select :kbd:`Scan Info`
You can view various details about the scan like scan tool name & version, options, platform etc.
More detailed explanation about the view can be found at :ref:`scan-info`

.. include:: ../../rst_snippets/scans-used.rst
Binary file not shown.
8 changes: 0 additions & 8 deletions docs/source/how-to-guides/special-topics/index.rst

This file was deleted.

This file was deleted.

8 changes: 6 additions & 2 deletions docs/source/overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,12 @@ This documentation is organized in six sections:
Underlying Technology
=====================

- ScanCode Workbench is based on `Electron <https://www.electronjs.org/>`__ and works on
Windows, OS X and Linux operating systems.
- ScanCode Workbench is a cross-platform application built using the `Electron <https://www.electronjs.org/>`__ framework that works on Windows, macOS and Linux operating systems.
- It uses
- `TypeScript <https://www.typescriptlang.org/>`__ as the primary language.
- `React <https://reactjs.org/>`__ for user interface.
- `Sequelize <https://sequelize.org/>`__ ORM for database access.
- `Sqlite3 <https://www.sqlite.org/index.html>`__ for managing sqlite database.

Platform Support
================
Expand Down
17 changes: 12 additions & 5 deletions src/services/models/flatFile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -392,13 +392,20 @@ export function flattenFile(file: any): FlattenedFile {
};
}

function getLicensePolicyLabel(policy: any) {
function getLicensePolicyLabel(policy: any[]) {
if (!policy) {
return;
} else if (!policy["label"]) {
return;
return [];
}
return [policy["label"]];

// @TODO - Support Comprehensive renderer in Tableview
// return policy.map((policy) => ({
// label: policy["label"],
// license_key: policy["license_key"],
// }));

return policy.map(
(policy) => `${policy["license_key"]} - ${policy["label"]}`
);
}

function getCopyrightValues(
Expand Down

0 comments on commit 4439789

Please sign in to comment.