Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Update the RTD documentation #427

Open
johnmhoran opened this issue Mar 18, 2020 · 1 comment
Open

Doc: Update the RTD documentation #427

johnmhoran opened this issue Mar 18, 2020 · 1 comment

Comments

@johnmhoran
Copy link
Member

We want to bring the RTD up-to-date.

@johnmhoran johnmhoran self-assigned this Mar 18, 2020
@mjherzog
Copy link
Member

mjherzog commented Mar 19, 2020

This Issue is to cover some important immediate work to upgrade the existing ScanCode Workbench documentation at https://scancode-workbench.readthedocs.io/en/develop/. The current goal is to get a new v3 baseline for documentation based on WB v3.1.1.

The specific near-term content requirements are to:

  • Restructure the TOC/Index to emulate what we have for ScanCode Toolkit with logical adaptations like UI Reference for WB instead of CLI Reference for TK
  • Fill in major missing topics like Getting Started, How-To Guides and Tutorials with content from WB v3
  • Replace the old animated GIFs with single screenshots like we have already for Conclusions (courtesy of Steven) - see Doc: Update UI Reference Section #441
  • Migrate the relevant content from the Wiki in GH to RTD and remove from GH Wiki when done
  • Replace the current functional doc in the top-level README.md with reference to RTD site.

We also need to use this cycle to document how to maintain RTD websites in general for AboutCode projects including how to make pull requests, how to run the "build" etc. This documentation probably belongs at https://aboutcode.readthedocs.io/en/latest/index.html# since it should be basically the same across our projects. It may make sense to take a different "mass-update" approach for the first round of work on upgrading the WB doc.

johnmhoran added a commit that referenced this issue Apr 1, 2020
* 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 <[email protected]>
@mjherzog mjherzog changed the title Update the RTD documentation Doc: Update the RTD documentation Apr 16, 2020
pranav1698 pushed a commit to pranav1698/scancode-workbench that referenced this issue Jan 14, 2021
* Addresses issue nexB#434.
* Some changes address issue nexB#427.
* Note that earlier commits on this branch also address issue nexB#427.

Signed-off-by: John M. Horan <[email protected]>
Vishal-raj-1 pushed a commit to Vishal-raj-1/scancode-workbench that referenced this issue Feb 3, 2021
* Addresses issue nexB#434.
* Some changes address issue nexB#427.
* Note that earlier commits on this branch also address issue nexB#427.

Signed-off-by: John M. Horan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants