Skip to content

Commit 89c0d2a

Browse files
jdaguiljdaguil
committed
Update Help Modal with links to wiki
* Remove old gifs and help text * Add links to updated wiki documentation Signed-off-by: Jillian Daguil <[email protected]>
1 parent 472249c commit 89c0d2a

File tree

2 files changed

+21
-80
lines changed

2 files changed

+21
-80
lines changed

‎assets/js/renderer.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717

1818
const fs = require('fs');
19+
const shell = require("electron").shell;
1920

2021

2122
$(document).ready(function () {
@@ -812,6 +813,12 @@ $(document).ready(function () {
812813
}
813814
});
814815

816+
// Open links in default browser
817+
$(".open-in-default").click((evt) => {
818+
evt.preventDefault();
819+
shell.openExternal(evt.target.href);
820+
});
821+
815822
restoreSplitterSizes();
816823
showClueButton.trigger("click");
817824
});

‎index.html‎

Lines changed: 14 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -277,93 +277,27 @@ <h2 class="modal-title" id="helpModalLabel">AboutCode Manager Help</h2>
277277
</div>
278278
<div class="modal-body">
279279
<h2>Overview</h2>
280-
<p>The AboutCode Manager allows you take the scan results
281-
from the ScanCode Toolkit and create a component-level
280+
<p>AboutCode Manager allows you take the scan results
281+
from the ScanCode and create a component-level
282282
software inventory. The conclusions (Concluded License,
283283
Concluded Owner, etc.) you make when creating your
284-
component can then be exported to a JSON file.
284+
component can be exported as a JSON file or saved as
285+
SQLite file.
285286
</p>
286-
<h3>Views</h3>
287-
<h4>Directory Tree</h4>
288-
<p> An interactive directory tree is always present on
289-
the left side of the application. The tree is
290-
expandable and collapsible. This allows the user to
291-
navigate the codebase structure. If a directory is
292-
selected, only that directory and its sub-files and
293-
folders will be shown in the view. Similarly, if a
294-
single file is selected, only information for that
295-
selected file will be shown.
296-
<img class="help-image" alt="directory screenshot" src="assets/images/codebase-tree.gif">
297-
</p>
298-
<h4>Table View</h4>
299-
<p>In the table view, the available clues detected by
300-
ScanCode Toolkit are shown in a tabular format. A
301-
user can see provenance clues such as license and
302-
copyright information detected by ScanCode Toolkit.
303-
A user can also see the file information (such as
304-
file type, file size, sha1, etc) and package
305-
information (package type, primary language of
306-
package) that was detected. The columns can be
307-
sorted as well as shown or hidden based on what the
308-
user’s preferences. Searching for specific clues
309-
(license names, copyrights, etc.) is also available
310-
in this view.
311-
<img class="help-image" alt="table view screenshot" src="assets/images/table-view.gif">
312-
</p>
313-
<h4>Conclusions View</h4>
314-
<p>The node view is where a user can create components
315-
from packages or files in their codebase.
316-
Selecting the nodes of the tree
317-
will expand or collapse the code structure. The
318-
numbers next to the file name are intended to help
319-
the user navigate to directories with the most clues.
320-
The first number is the number of files contained in
321-
that directory. The second number is the number of
322-
detected clues from ScanCode Toolkit (for example,
323-
detected license and detected copyright). These
324-
numbers can help a user navigate to directories
325-
that have a large amount of scancode clues that were
326-
detected in proportion to files.
327-
</p>
328-
<img class="help-image" alt="node view screenshot" src="assets/images/node-view.gif">
329-
<h5>Creating Components</h5>
330-
<p>A Component is a set of software packages or files
331-
that share a name, version, owner, license and
332-
copyright. A conclusion in the AboutCode Manager
333-
refers to documentation of your conclusion about the
334-
owner, copyright, and license for some set of
335-
software files at a Component level. To create a
336-
component, select the file name. A form appears
337-
where you can fill in concluded information.
338-
</p>
339-
<p>The following fields are available when creating a component:
287+
<h3>Basics</h3>
340288
<ul>
341-
<li>Status - Used to document status of component creation (Analyzed - A component has been created, Needs Attention - A component is flagged for further review, Original Code - A component is from your organization)</li>
342-
<li>Component - Primary component (usually a file, directory or library name)</li>
343-
<li>Version - Component Version Number</li>
344-
<li>License - This is the license for the Component</li>
345-
<li>Owner - This is the owner of the Component</li>
346-
<li>Copyright - The Copyright notice that applies to the Component under the License.</li>
347-
<li>Notes - Comments that provide additional insight into the findings.</li>
289+
<li><a class="open-in-default" href="https://github.com/nexB/aboutcode-manager/wiki/Building">Building</a></li>
290+
<li><a class="open-in-default" href="https://github.com/nexB/aboutcode-manager/wiki/AboutCode-Manager-Views">AboutCode Manager Views</a></li>
291+
<li><a class="open-in-default" href="https://github.com/nexB/aboutcode-manager/wiki/Platform-Support">Platform Support</a></li>
348292
</ul>
349-
<img class="help-image" alt="create component screenshot" src="assets/images/create-component.gif">
350-
</p>
351-
<h5>Node colors</h5>
352-
<p>
293+
<h3>Tutorials</h3>
353294
<ul>
354-
<li>Blue - The node is blue when no status has been set for the file or directory</li>
355-
<li>Green - The node is green when a component is created.</li>
356-
<li>Red - The node is red when the Status is set to Needs Attention</li>
357-
<li>Purple - The node is purple when the Status is set to Original Code</li>
295+
<li><a class="open-in-default" href="https://github.com/nexB/aboutcode-manager/wiki/Import-JSON-%26-Export-JSON">Import JSON & Export JSON</a></li>
296+
<li><a class="open-in-default" href="https://github.com/nexB/aboutcode-manager/wiki/Open-%26-Save-a-SQLite-File">Open & Save a SQLite File</a></li>
297+
<li><a class="open-in-default" href="https://github.com/nexB/aboutcode-manager/wiki/Creating-Components">Creating Components</a></li>
298+
<li><a class="open-in-default" href="https://github.com/nexB/aboutcode-manager/wiki/Navigating-the-Chart-Summary-View">Navigating the Chart Summary View</a></li>
299+
<li><a class="open-in-default" href="https://github.com/nexB/aboutcode-manager/wiki/Navigating-the-Node-View">Navigating the Node View</a></li>
358300
</ul>
359-
It’s important to note that if you create a component at a directory level, the files underneath that directory are considered analyzed at that level. Our experience with hundreds of software audit projects is that you normally want to conclude and track provenance for software at the Component level.
360-
</p>
361-
<h3>Navigation</h3>
362-
<h4>Panning</h4>
363-
<p>Use the mouse to pan. Hold down click and move mouse</p>
364-
<h4>Zooming</h4>
365-
<p>Use the scroll wheel to zoom. On Mac use two fingers to zoom.</p>
366-
367301
</div>
368302
<div class="modal-footer">
369303
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>

0 commit comments

Comments
 (0)