Add Final Improvements/Changes before Migrating - #33
Conversation
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
This commit adds support for pip install and Python 3 install methods. Also standardizes scan commands across the docs. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
d70c323 to
94b50ca
Compare
This adds Intersphinx related docs and seperates scancode-toolkit doc contributing page from the aboutcode page. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
a71253d to
f1b2414
Compare
pombredanne
left a comment
There was a problem hiding this comment.
This is looking quite good to me! 👍
Tell me when you want me to merge this.
|
@pombredanne I'll push some more changes in a couple of hours, for you to review. :) |
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
ed72001 to
cdc4976
Compare
| Documentation Support | ||
| ^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| ``pip install`` | ||
| ^^^^^^^^^^^^^^^ | ||
| ``pip install`` Support | ||
| ^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| Python 3 Support | ||
| ^^^^^^^^^^^^^^^^ |
There was a problem hiding this comment.
I'd also need suggestions on this file, i.e. scancode-toolkit/getting-started/whats-new.rst. Basically on this Brief Summary Of Changes section, should it have more points? Does this page make sense? The [ToDo] comment in this file explains what I'm proposing.
There was a problem hiding this comment.
We do have a CHANGELOG file here: https://github.com/nexB/scancode-toolkit/blob/develop/CHANGELOG.rst
Maybe all we need to do is link to it in whats-new.rst
There was a problem hiding this comment.
There was a problem hiding this comment.
On a side note, why doesn't the changelog include version 3.1.1?
There was a problem hiding this comment.
The changelog will eventually be updated I believe.
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
|
Just to refer to later, this PR might also solve this issue - #33 |
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
steven-esser
left a comment
There was a problem hiding this comment.
Why do we remove the ./ in front of all these scancode commands? This is necessary for people who want to run scancode right after cloning, without running virualenv commands. Many people expect scancode to work this way (with the ./scancode invocation) and I think we should leave them in.
@MaJuRG My thoughts on this were, if I did add extensive documentation on different install methods, and how that changes the scan commands, in the synopsis and install pages, and added reminders in all other pages that using different install methods require different commands. What's your take on this? |
steven-esser
left a comment
There was a problem hiding this comment.
Yes, on second thought I think this is fine without the ./
We have it documented on the README, which gives enough context for me.
Migrate all scancode-toolkit documentation from aboutcode till this commit - aboutcode-org/aboutcode@faea9fc Last pull request adding scancode docs was aboutcode-org/aboutcode#33 Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
|
Let's make sure we are clear: there are eventually multiple ways to use scancode-toolkit:
2 and 3 are advanced modes and 1 should be always offered as the default. |
|
@pombredanne Right. I'm clear on this now. I'll push some updates to the documentation accordingly, so this is more clearly understood across all pages. Apart from that, even after documenting such that it's targeted and helpful to both developers and non-developers, there's still the scan commands which are there throughout the documentation, so whether they should be shown with or without Now people who are most likely to get confused are non-developers, i.e.
Considering that scan command variation for different installation methods is documented everywhere (where the user will most likely start reading from), I think it's better if we don't use |
|
I'll push related changes in aboutcode-org/scancode-toolkit#1851. I've updated the PR name accordingly. |
Migrate all scancode-toolkit documentation from aboutcode till this commit - aboutcode-org/aboutcode@faea9fc Last pull request adding scancode docs was aboutcode-org/aboutcode#33 Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Jono Yang <jyang@nexb.com>
* Create copyright statement from holder information Signed-off-by: Jono Yang <jyang@nexb.com>
* This is used for the case where we are starting off a project and have not yet generated requirements files Signed-off-by: Jono Yang <jyang@nexb.com>
Signed-off-by: Jono Yang <jyang@nexb.com>
* Add --init option to configure.bat
* Update help text in configure and configure.bat
Signed-off-by: Jono Yang <jyang@nexb.com>
Signed-off-by: Jono Yang <jyang@nexb.com>
Signed-off-by: Jono Yang <jyang@nexb.com>
* Update README.rst Signed-off-by: Jono Yang <jyang@nexb.com>
* Update README.rst with instructions for post-initialization usage Signed-off-by: Jono Yang <jyang@nexb.com>
* Replace references to scancode-toolkit repo with links to the skeleton repo
* Remove --python option from configure.bat
Signed-off-by: Jono Yang <jyang@nexb.com>
This PR essentially solves all issues mentioned in #32 and adds other final changes before migration.
[Work In Progress]
Signed-off-by: Ayan Sinha Mahapatra ayansmahapatra@gmail.com