Adds Documentation Versioning, Command Line Options, Changelogs - #26
Conversation
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
|
@AyanSinhaMahapatra Looks good so far. If it is still a work-in-progress let me know when you are ready. We can chat about it later. |
|
@DennisClark it is still WIP. I have work done on my local repo, not pushing just yet because have some issues to talk to you first today. |
… Rule This commit completely changes the documentation structure, dividing it into sub-folder adhering to the 4 functions - tutorials, how-to guides, referance and explanation. Also adds the Getting Started, Contributing and Miscellaneous sections. This commit contains only the index.rst files, and later commits will add modular changes in this restructuring. This is very close to the structure that will remain at last, but a lot of content will be added subsequently in the files, and different branches for different versions. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Moves required files into Getting Started Section. Also adds What's New File, which will explain what a new release contains. More Content Will be added later. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Moves files that helps new contributors to this section, and adds What's New (in this release), Documentation Contribution Guidelines (To Be Expanded More). Also moves in data folders. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Moves Files that doesn't fall into other categories into this section. Also restructures faq.rst significantly. Questions moved into How To section and more content will be added in later commits. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Tutorials are guides to perform simple but important tasks, to get users started using Scancode. How To Guides are more goal oriented, helps complete harder objectives. This is according to the 4 functions rule for documentation. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Initial Files are Added, content to be added in Version Specific Branches v2.2.1 and v3.1.1 which branches from this commit. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
|
Initiates Documentation Structure. [d9ca04b] |
|
Since I cannot add Branches in this repository, @DennisClark you have to at this point of time, as we discussed before. |
|
I'll attach a document explaining everything shortly. Also Fixing the bug for Travis-CI check. |
Documentation Style is enforced by using Doc8 and Doc Contribution Guide is updated accordingly. 300+ Style errors fixed. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
b049637 to
7e62d83
Compare
|
Checks Cleared. |
|
@AyanSinhaMahapatra This is looking good. Review and discussion in progress. Planning to take action in a day or two. |
This commits fixes some spelling mistakes and Adds guide to use GNU Aspell to do the same. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
|
@AyanSinhaMahapatra this is looking great! I discussed with @DennisClark about branches and tags and I think that after all it might be best to have the doc for each project in each project repo (e.g. the ScanCode toolkit docs in the scancode-toolkit and so on) and that this Aboutcode repo would be for cross project documentations and as the gateway to each project-level docs. |
|
Hi @pombredanne I've prepared a doc discussing these issues, and what my plan is. Would you check once and then let me know? Doc Link |
|
@AyanSinhaMahapatra Thanks! |
|
BTW a tiny nit picking: we prefer to use an imperative style in the commit messages, like if you were giving an order to the codebase.
we prefer the imperative:
It also makes sense to keep the subject line (the first line) under 50 characters. |
|
I would be more careful on the commit messages next time. Thanks for
reminding me.
…On Fri 27 Sep, 2019, 6:02 PM Philippe Ombredanne, ***@***.***> wrote:
BTW a tiny nit picking: we prefer to use an imperative style in the commit
messages, like if you were giving an order to the codebase.
So for instance instead of:
Adds Documentation Versioning, Command Line Options, Changelogs
we prefer the imperative:
Add Documentation Versioning, Command Line Options, Changelogs
It also makes sense to keep the subject line (the first line) under 50
characters.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#26>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AGENWYVUDGPJQCG2ICYKPHDQLX4ODANCNFSM4ITS3XJQ>
.
|
Create junction from Scripts to bin
This adds to the existing documentation a versioning system which is compatible with ReadTheDocs hosting, adds command-line options, changelogs and updates the documentation for scancode-toolkit so that it the documentation is consistent for all the scancode-toolkit versions. [Work in Progress]
Signed-off-by: Ayan Sinha Mahapatra ayansmahapatra@gmail.com