Remove conclusion from docs

Signed-off-by: Omkar Phansopkar <[email protected]>
aboutcode-org · May 1, 2022 · 0244dec · 0244dec
1 parent 5564589
commit 0244dec
Show file tree

Hide file tree

Showing 13 changed files with 8 additions and 185 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -16,6 +16,7 @@ New Features
 - Update app icon to a more visible one #382
 - Add color to DataTables "Progress..." pop-up #407
 - Update the display of scan headers #400
+- Remove ability to edit conclusions & remove conclusions view
 
 Bug Fixes
 ~~~~~~~~~

diff --git a/README.md b/README.md
@@ -5,14 +5,9 @@
 
 ScanCode Workbench provides an advanced visual UI to help you quickly evaluate
 license and other notices identified by 
-[ScanCode](https://github.com/nexB/scancode-toolkit/) and record your conclusion
-about the effective license(s) for a component.
+[ScanCode](https://github.com/nexB/scancode-toolkit/).
 [ScanCode](https://github.com/nexB/scancode-toolkit/) detects licenses, copyrights 
-and other interesting information in your code. ScanCode Workbench allows you to take the
-scan results from ScanCode and create conclusions. By creating these conclusions 
-within your codebase, you are creating a software inventory of your product. 
-The conclusions (Concluded License, Concluded Owner, etc.) you make when 
-creating your conclusion can be exported as a JSON file or saved as SQLite file.
+and other interesting information in your code.
 
 ScanCode Workbench is based on
 [Electron](https://electron.atom.io/) and will be the primary desktop/GUI tool 

diff --git a/assets/app/js/renderer.js b/assets/app/js/renderer.js
@@ -121,7 +121,7 @@ $(document).ready(() => {
   // Save a SQLite Database file
   saveSQLiteFileButton.click(saveSQLite);
 
-  // Show ScanData DataTable. Hide node view and conclusion summary table
+  // Show ScanData DataTable. Hide node view
   showScanDataButton.click(() => {
     splitter.show();
     scanDataTable.redraw();
@@ -414,7 +414,7 @@ $(document).ready(() => {
     });
   }
 
-  /** Export JSON file with original ScanCode data and conclusions that have been created */
+  /** Export JSON file with original ScanCode data */
   function exportJson() {
     dialog.showSaveDialog({
       properties: ['openFile'],
@@ -455,15 +455,14 @@ $(document).ready(() => {
 
       Promise.all([scanCodeInfoPromise, workbenchInfoPromise,
         filesCountPromise, scanDataFilesPromise])
-        .then(([scanCodeInfo, workbenchInfo, filesCount, scanDataFiles, conclusions]) => {
+        .then(([scanCodeInfo, workbenchInfo, filesCount, scanDataFiles]) => {
           const json = {
             workbench_notice: workbenchInfo.workbench_notice,
             workbench_version: workbenchInfo.workbench_version,
             scancode_version: scanCodeInfo.scancode_version,
             scancode_options: scanCodeInfo.scancode_options,
             files_count: filesCount,
-            files: scanDataFiles,
-            conclusions: conclusions
+            files: scanDataFiles
           };
 
           fs.writeFile(fileName, JSON.stringify(json), (err) => {

diff --git a/docs/source/how-to-guides/create-conclusions/create-conclusions.rst b/docs/source/how-to-guides/create-conclusions/create-conclusions.rst
diff --git a/docs/source/how-to-guides/create-conclusions/data/conclusion-form-01.png b/docs/source/how-to-guides/create-conclusions/data/conclusion-form-01.png
diff --git a/docs/source/how-to-guides/create-conclusions/data/scandatatable-01.png b/docs/source/how-to-guides/create-conclusions/data/scandatatable-01.png
diff --git a/docs/source/how-to-guides/create-conclusions/index.rst b/docs/source/how-to-guides/create-conclusions/index.rst
diff --git a/docs/source/how-to-guides/index.rst b/docs/source/how-to-guides/index.rst
@@ -18,7 +18,6 @@ a ``-clipeu`` scan of ``e2fsprogs-1.45.6.tar.gz``.
    load-your-data/index
    lookup-scan-version/index
    explore-your-data/index
-   create-conclusions/index
    export-json-records/index
    troubleshooting/index
    special-topics/index
diff --git a/docs/source/overview/index.rst b/docs/source/overview/index.rst
@@ -11,8 +11,6 @@ scans.  With ScanCode Workbench, you can:
 -  Load a `ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`__ ``.json`` scan of
    your codebase.
 -  Use an advanced visual UI to analyze license and other notices identified by ScanCode Toolkit.
--  Record your conclusions about the effective license(s) for a component or package.
--  Easily export your conclusions as a ``.json`` file.
 
 Organization of the Documentation
 =================================

diff --git a/docs/source/ui-reference/conclusion-view.rst b/docs/source/ui-reference/conclusion-view.rst
diff --git a/docs/source/ui-reference/index.rst b/docs/source/ui-reference/index.rst
@@ -15,4 +15,3 @@
    license-info-dashboard
    package-info-dashboard
    chart-summary-view
-   conclusion-view
diff --git a/index.html b/index.html
@@ -381,11 +381,7 @@ <h2 class="modal-title" id="helpModalLabel">ScanCode Workbench Help</h2>
                     <h3>Overview</h3>
                     <p>
                         ScanCode Workbench allows you take the scan results
-                        from the ScanCode and create a conclusion-level
-                        software inventory. The conclusions (Concluded License,
-                        Concluded Owner, etc.) you make when creating your
-                        conclusion can be exported as a JSON file or saved as
-                        SQLite file. For more information, see our
+                        from the ScanCode and evaluate it using charts
                     </p>
                     <p>
                         For more details, see our

diff --git a/test/workbenchDB.test.js b/test/workbenchDB.test.js
@@ -331,60 +331,6 @@ describe('checkWorkbenchDB', () => {
     });
   });
 
-  describe('setConclusion', () => {
-    it('should create a conclusion in Component Table', () => {
-      const workbenchDB = new WorkbenchDB();
-      const conclusion = {
-        'license_expression': 'apache-1.1',
-        'copyright': '(c) 2004 by Henrik Ravn',
-        'copyrights': [
-          {
-            'statements': [
-              '(c) 2004 by Henrik Ravn'
-            ]
-          }
-        ],
-        'path': 'samples',
-        'review_status': 'attention',
-        'name': 'samples',
-        'version': '1.0',
-        'owner': 'Jean-loup Gailly, Brian Raiter',
-        'homepage_url': 'http://www.jboss.org/',
-        'programming_language': 'C',
-        'notes': ''
-      };
-
-      const conclusion2 = {
-        'license_expression': 'zlib',
-        'copyright': 'Copyright (c) 1995-2013 Jean-loup Gailly and Mark Adler',
-        'copyrights': [
-          {
-            'statements': [
-              'Copyright (c) 1995-2013 Jean-loup Gailly and Mark Adler'
-            ]
-          }
-        ],
-        'path': 'samples/zlib',
-        'review_status': 'analyzed',
-        'name': 'zlib',
-        'version': '1.0',
-        'owner': 'Jean-loup Gailly and Mark Adler',
-        'homepage_url': 'http://www.zlib.net/',
-        'programming_language': 'C#',
-        'notes': ''
-      };
-
-      return workbenchDB.sync
-        .then(() => workbenchDB.setConclusion(conclusion))
-        .then(() => workbenchDB.db.Conclusion.count())
-        .then((rowCount) => assert.strictEqual(rowCount, 1))
-        .then((row) => assert.containSubset(row.toJSON(), conclusion))
-        .then(() => workbenchDB.setConclusion(conclusion2))
-        .then(() => workbenchDB.db.Conclusion.count())
-        .then((rowCount) => assert.strictEqual(rowCount, 2));
-    });
-  });
-
   describe('getFileCount', () => {
     it('should return the ScanCode files_count', () => {
       const workbenchDB = new WorkbenchDB();