Skip to content

Start RTD restructuring - #433

Merged
steven-esser merged 12 commits into
developfrom
restructure-rtd
Apr 2, 2020
Merged

steven-esser merged 12 commits into
developfrom
restructure-rtd

Conversation

@johnmhoran

Copy link
Copy Markdown
Member

@MaJuRG This is just the initial stage of the restructuring and fleshing-out work -- more to come.

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
@johnmhoran
johnmhoran requested a review from steven-esser April 1, 2020 02:07
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
Signed-off-by: John M. Horan <johnmhoran@gmail.com>

@steven-esser steven-esser left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good. Just made a few comments for now. When this is in a final state, let me know and I will review + merge when complete.

Comment thread docs/source/getting-started/index.rst Outdated

If you're ready, keep on reading this documentation for more information on how to use
ScanCode Workbench.
:guilabel:`[The samples need to be updated from 2.9.2 to the current version of SCTK.]`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes they do ;) Can you enter a ticket for this (if we do not already have one). It doesnt need to be super detailed, just this sentence.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @MaJuRG -- I'll assign to myself and try to wrap up today or tomorrow.

Comment on lines +8 to +9
Once you've imported your JSON scan and saved it as SQLite, in most cases you'll continue your
review and analysis work solely in the SQLite file.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would get rid of "in most cases". Whether the user wants it or not, all the reviewing and analysis work is done via the sqlite file (by design).

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

Comment thread docs/source/license.rst Outdated
Comment on lines +8 to +9
- Multiple licenses (LGPL, MIT, BSD, etc.) for third-party components.
- See the `NOTICE <https://github.com/nexB/scancode-workbench/blob/develop/NOTICE>`__ file for more details. *[The copyright date needs to be updated or removed.]*
- See the `NOTICE <https://github.com/nexB/scancode-workbench/blob/develop/NOTICE>`__ file for more details. :guilabel:`[The copyright date needs to be updated or removed.]`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could use a ticket for this task as well.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ticket entered -- we have a few open questions and then I'll take care of this asap.

* Addresses issue #434.
* Some changes address issue #427.
* Note that earlier commits on this branch also address issue #427.

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
* This addresses issue #435.
* Also removes to-dos re NOTICE, sample scans (issue #434).

Signed-off-by: John M. Horan <johnmhoran@gmail.com>
@steven-esser
steven-esser merged commit d723e11 into develop Apr 2, 2020
@steven-esser
steven-esser deleted the restructure-rtd branch April 2, 2020 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants