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.

Sign up for GitHub

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

Jump to bottom

Add improved documentation for V2021 #1146

Open
5 of 6 tasks
pombredanne opened this issue Jul 27, 2018 · 5 comments
Open
5 of 6 tasks

Add improved documentation for V2021 #1146

pombredanne opened this issue Jul 27, 2018 · 5 comments
Labels
documentation long running must have

Comments

@pombredanne
Copy link
Member

pombredanne commented Jul 27, 2018 •
edited by AyanSinhaMahapatra
Loading

This should consolidate anything that may be in the wiki and provide comprehensive usage documentation
@steven-esser
Copy link
Contributor

We have this currently https://github.com/nexB/scancode-toolkit/wiki/License-Policy-Plugin.

The plugin itself may need to be better documented.

@pombredanne pombredanne added this to the v3.0 milestone Nov 5, 2018
pombredanne added a commit that referenced this issue Nov 6, 2018
@pombredanne
Add more entries ro Changelog #1146
aa55188 
Signed-off-by: Philippe Ombredanne <[email protected]>
pombredanne added a commit that referenced this issue Nov 6, 2018
@pombredanne
Add more entries to Changelog #1146
90e6cb5 
Signed-off-by: Philippe Ombredanne <[email protected]>
pombredanne added a commit that referenced this issue Nov 6, 2018
@pombredanne
Update CHANGELOG with latest changes #1146
8fbf269 
This is a catch up commit. This should be kept up to date going forward

Signed-off-by: Philippe Ombredanne <[email protected]>
pombredanne added a commit that referenced this issue Nov 6, 2018
@pombredanne
Update CHANGELOG with latest changes #1146
86722b3 
This is a catch up commit. This should be kept up to date going forward

Signed-off-by: Philippe Ombredanne <[email protected]>
@pombredanne pombredanne mentioned this issue Nov 6, 2018
Closed
@pombredanne
Copy link
Member Author

This is really what @AyanSinhaMahapatra is working on.

@AyanSinhaMahapatra
Copy link
Member

AyanSinhaMahapatra commented Oct 24, 2019 •
edited
Loading

So, #1784 is the first step. Making sure tests for documentation builds are in place, with all requirements in thirdparty/.
Next, I'll test cross-sphinx links (To maintain links with nexB/aboutcode). Then comes the actual migration of the docs.

@AyanSinhaMahapatra AyanSinhaMahapatra mentioned this issue Nov 5, 2019
Open
17 tasks
@AyanSinhaMahapatra
Copy link
Member

AyanSinhaMahapatra commented Nov 21, 2019 •
edited
Loading

@pombredanne This task list can also be updated, only this is remaining. All other issues are closed.

@AyanSinhaMahapatra
Copy link
Member

@pombredanne I updated the task list.

@mjherzog mjherzog changed the title Add improved documentation for V3.0 Add improved documentation for V3 May 12, 2020
@pombredanne pombredanne changed the title Add improved documentation for V3 Add improved documentation for V2021 Apr 1, 2021
@pombredanne pombredanne removed this from the v3.2 milestone Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation long running must have
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@pombredanne @steven-esser @AyanSinhaMahapatra