Skip to content

Commit 34fa0bb

Browse files
steven-essersteven-esser
committed
Update Help documentation in app
* Update workbench help modal with links to GitHub, Read The Docs and the Issue tracker * Update the Welcome page buttons to link to GitHub, Read The Docs and the Issue tracker * Update help menu options to link to GitHub, Read The Docs and the Issue tracker * Update the README links to point to Read The Docs * Update ISSUE_TEMPLATE.md with link to Read The Docs Addresses: #412 Signed-off-by: Steven Esser <[email protected]>
1 parent 50c05fc commit 34fa0bb

File tree

5 files changed

+1165
-1181
lines changed

5 files changed

+1165
-1181
lines changed

‎ISSUE_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
### Description
22
Please leave a brief discription of the bug or feature request:
33
* if reporting a bug, tell us how to reproduce the issue.
4-
* Check the Develop Console tab and copy any error text there might be: https://github.com/nexB/scancode-workbench/wiki/Check-for-Errors-in-the-Developer-Tools
4+
* Check the Develop Console tab and copy any error text there might be: https://scancode-workbench.readthedocs.io/en/develop/basics/check_for_errors_in_the_developer_tools.html
55

66
### System configuration
77
For bug reports, it really helps us to know:

‎README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ ScanCode Workbench is based on
1919
for using nexB’s [AboutCode tools](https://github.com/nexB/aboutcode). This app
2020
works on Windows, OS X and Linux operating systems.
2121

22-
![ScanCode Workbench](https://github.com/nexB/scancode-workbench/wiki/scancode-workbench-chart-summary.gif)
22+
![ScanCode Workbench](https://scancode-workbench.readthedocs.io/en/develop/_images/scancode-workbench-chart-summary.gif)
2323

2424
## Using
2525

@@ -29,7 +29,7 @@ can find `ScanCode-Workbench` under `dist/ScanCode-Workbench-<os>-x64-<version>`
2929
* ScanCode Workbench >= v2 is only compatible with scans from
3030
[ScanCode v2.0.0](https://github.com/nexB/scancode-toolkit/releases) and
3131
above which are run with the ScanCode `-i` option. For a list of available ScanCode
32-
options see [How To: Set what will be detected in a scan](https://github.com/nexB/scancode-toolkit/wiki/How-To:-Set-what-will-be-detected-in-a-scan)
32+
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)
3333

3434
```bash
3535
./scancode -clipeu <input> <output_file>
@@ -40,16 +40,16 @@ ScanCode Workbench in order to get a sense of its functionality and the types of
4040
information captured by a scan. The samples are located at
4141
[https://github.com/nexB/scancode-workbench/tree/develop/samples](https://github.com/nexB/scancode-workbench/tree/develop/samples).
4242
* Import a ScanCode JSON file, and see what components are in your software! See
43-
the [wiki](https://github.com/nexB/scancode-workbench/wiki#tutorials) for more
44-
documentation on how to use ScanCode Workbench.
43+
the [documentation](https://scancode-workbench.readthedocs.io) for more
44+
information on how to use ScanCode Workbench.
4545

46-
![Import a JSON file](https://github.com/nexB/scancode-workbench/wiki/import-json-file.gif)
46+
![Import a JSON file](https://scancode-workbench.readthedocs.io/en/develop/_images/import-json-file.gif)
4747

4848
## Building
4949

5050
You'll need [Node.js](https://nodejs.org) (which comes with [npm](http://npmjs.com))
5151
installed on your computer in order to build this app. For a list of platform
52-
specific requirements, see the Building section of the [wiki](https://github.com/nexB/scancode-workbench/wiki/Building).
52+
specific requirements, see the Building section of the [documentation](https://scancode-workbench.readthedocs.io/en/develop/basics/building.html).
5353
Then, from your command line:
5454

5555
```bash

‎index.html

+21-38
Original file line numberDiff line numberDiff line change
@@ -132,27 +132,14 @@ <h3>Start:</h3>
132132
</div>
133133
</div>
134134
<div class="col-sm-8">
135-
<h3>Learn:</h3>
135+
<h3>Learn and Contribute:</h3>
136136
<div class="btn-group-vertical" role="group" aria-label="...">
137-
<a href="https://github.com/nexB/scancode-toolkit/wiki/How-To:-Run-a-scan" class="btn btn-lg btn-default">How to run a scan with ScanCode Toolkit</a>
138-
<a href="https://github.com/nexB/scancode-workbench/wiki/ScanCode-Workbench-Views" class="btn btn-lg btn-default">About ScanCode Workbench's various views</a>
139-
<a href="https://github.com/nexB/scancode-workbench/wiki/Creating-Conclusions" class="btn btn-lg btn-default">How to create Conclusions</a>
137+
<a href="https://github.com/nexB/scancode-workbench/" class="btn btn-lg btn-default">GitHub Repository</a>
138+
<a href="https://scancode-workbench.readthedocs.io" class="btn btn-lg btn-default">Documentation</a>
139+
<a href="https://github.com/nexB/scancode-workbench/issues" class="btn btn-lg btn-default">Report a Bug or Request a Feature</a>
140140
</div>
141141
</div>
142142
</div>
143-
<div class="row" style="padding-top:50px">
144-
<div class="col-sm-6">
145-
<h4>Additional Help and Documentation:</h4>
146-
<ul>
147-
<li><a href="https://github.com/nexB/scancode-workbench/wiki/">ScanCode Workbench Wiki</a></li>
148-
<li><a href="https://github.com/nexB/scancode-workbench/issues/">ScanCode Workbench Issue Tracker</a></li>
149-
<li><a href="https://github.com/nexB/scancode-workbench/wiki/Check-for-Errors-in-the-Developer-Tools">Checking for Errors</a></li>
150-
</ul>
151-
</div>
152-
<div class="col-sm-6">
153-
<!-- pass -->
154-
</div>
155-
</div>
156143
</div>
157144
</div>
158145
</div>
@@ -535,33 +522,29 @@ <h4 class="modal-title" id="myModalLabel">Upload Conclusions to DejaCode</h4>
535522
<h2 class="modal-title" id="helpModalLabel">ScanCode Workbench Help</h2>
536523
</div>
537524
<div class="modal-body">
538-
<h2>Overview</h2>
539-
<p>ScanCode Workbench allows you take the scan results
525+
<h3>Overview</h3>
526+
<p>
527+
ScanCode Workbench allows you take the scan results
540528
from the ScanCode and create a conclusion-level
541529
software inventory. The conclusions (Concluded License,
542530
Concluded Owner, etc.) you make when creating your
543531
conclusion can be exported as a JSON file or saved as
544532
SQLite file. For more information, see our
545-
<a href="https://github.com/nexB/scancode-workbench/wiki">wiki</a>.
546533
</p>
547-
<h3>Basics</h3>
548-
<ul>
549-
<li><a class="open-in-default" href="https://github.com/nexB/scancode-workbench/wiki/ScanCode-Workbench-Views">ScanCode Workbench</a></li>
550-
<li><a class="open-in-default" href="https://github.com/nexB/scancode-workbench/wiki/Building">Building</a></li>
551-
<li><a class="open-in-default" href="https://github.com/nexB/scancode-workbench/wiki/Platform-Support">Platform Support</a></li>
552-
</ul>
553-
<h3>Tutorials</h3>
554-
<ul>
555-
<li><a class="open-in-default" href="https://github.com/nexB/scancode-workbench/wiki/Import-JSON-and-Export-JSON">Import JSON and Export JSON</a></li>
556-
<li><a class="open-in-default" href="https://github.com/nexB/scancode-workbench/wiki/Open-and-Save-a-SQLite-File">Open and Save a SQLite File</a></li>
557-
<li><a class="open-in-default" href="https://github.com/nexB/scancode-workbench/wiki/Creating-Components">Creating Components</a></li>
558-
<li><a class="open-in-default" href="https://github.com/nexB/scancode-workbench/wiki/Navigating-the-Chart-Summary-View">Navigating the Chart Summary View</a></li>
559-
<li><a class="open-in-default" href="https://github.com/nexB/scancode-workbench/wiki/Navigating-the-Node-View">Navigating the Node View</a></li>
560-
</ul>
561-
<h3>Debugging</h3>
562-
<ul>
563-
<li><a class="open-in-default" href="https://github.com/nexB/scancode-workbench/wiki/Check-for-Errors-in-the-Developer-Tools">Check for Errors in the Developer Tools</a></li>
564-
</ul>
534+
<p>
535+
For more details, see our
536+
<a href="https://github.com/nexB/scancode-workbench/">GitHub Repository</a>.
537+
</p>
538+
<h3>Learn More:</h3>
539+
<p>
540+
Check out the ScanCode-Workbench
541+
<a href="https://scancode-workbench.readthedocs.io">Documentation</a>.
542+
</p>
543+
<h3>Having Trouble?</h3>
544+
<p>
545+
Report a bug or request a feature on the ScanCode-Workbench
546+
<a href="https://github.com/nexB/scancode-workbench/issues">Issues Page</a>.
547+
</p>
565548
</div>
566549
<div class="modal-footer">
567550
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>

‎main.js

+5-4
Original file line numberDiff line numberDiff line change
@@ -233,9 +233,9 @@ function getTemplate() {
233233
type: 'separator'
234234
},
235235
{
236-
label: 'Learn More',
236+
label: 'GitHub Repoistory',
237237
click: () => shell.openExternal(
238-
'https://github.com/nexB/scancode-workbench/wiki')
238+
'https://github.com/nexB/scancode-workbench/')
239239
},
240240
{
241241
label: 'Licensing Information',
@@ -248,12 +248,13 @@ function getTemplate() {
248248
}
249249
},
250250
{
251+
// TODO: make this version specific?
251252
label: 'Documentation',
252253
click: () => shell.openExternal(
253-
`https://github.com/nexB/scancode-workbench/blob/v${packageJson.version}/README.md`)
254+
`https://scancode-workbench.readthedocs.io`)
254255
},
255256
{
256-
label: 'Search Issues',
257+
label: 'Issue Tracker',
257258
click: () => shell.openExternal(
258259
'https://github.com/nexB/scancode-workbench/issues')
259260
}

0 commit comments

Comments
 (0)