Update Docs with Changes in Wiki - #29
Conversation
This commit updates documentation from recent changes in scancode-toolit Wiki. Includes major changes in Roadmap and other minor changes in Plugin Architecture and License Policy Plugin. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
This Commit Initiates the Plugin Section by moving the plugin_arch and licence_policy_plugin files. Also adds minor changes to index.rst files. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
This commit updates the Docs from deltacode Wiki, the GSOC 2019 Report, and minor changes in deltacode_scoring.rst Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
|
|
||
| The following command will output the scan results in JSON format to ``stdout`` (In the Terminal):: | ||
|
|
||
| ./scancode -clpieu --jsonlines - samples/ |
There was a problem hiding this comment.
We may want to remove --jsonlines here and just use --json-pp -. We mainly just want to show users how to output to stdout. I just think using different output format in this example complicates this for a new user more than it should.
Eventually we can have another page detailing the other various output formats.
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
steven-esser
left a comment
There was a problem hiding this comment.
This looks good to me. @DennisClark @pombredanne mind doing a quick review before I merge this in?
pombredanne
left a comment
There was a problem hiding this comment.
Thanks! I made a few first set of comments inline
| @@ -0,0 +1,102 @@ | |||
| Google Summer of Code 2017 - Final report | |||
| Automatic vs. Manual Installation | ||
| --------------------------------- | ||
|
|
||
| Automatic |
There was a problem hiding this comment.
May be it would be better to call this built-in and optional rather than automatic and manual?
There was a problem hiding this comment.
Also the tutorial should be focused on optional plugins IMHO and leave aside the builtin ones as another topic
There was a problem hiding this comment.
@pombredanne Here I just replicated this wiki by @johnmhoran, i.e. this isn't the plugin docs that I'm writing on my own. Should I still go on and make these requested changes?
There was a problem hiding this comment.
yes, always feel free to update the content as you go so that this is better and improved.
| global-exclude *.py[co] __pycache__ *.*~ | ||
|
|
||
| 4. ``NOTICE`` -- See, e.g., | ||
| `/plugins/scancode-ignore-binaries/NOTICE <https://github.com/nexB/scancode-toolkit/blob/develop/plugins/scancode-ignore-binaries/NOTICE>`__ |
There was a problem hiding this comment.
Let's be simple for contributed plugins and eschew a notice
There was a problem hiding this comment.
@pombredanne Could you please explain what you mean here?
There was a problem hiding this comment.
I mean we may not want a notice... but now that you said it was ported from the wiki, we can update that later.... so nothing to do for you for now.
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
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.
Looks good to me. @DennisClark I think this is good enough for now, but could you take a quick look.
Most of this is copied from the project's wikis.
DennisClark
left a comment
There was a problem hiding this comment.
One very simple change requested:
"code is out there somewhere but getting it is harder than needed. This a"
would be better as
"code is out there somewhere but getting it is often too difficult. This is a"
That's it! Otherwise, all the changes are great.
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
|
@DennisClark Done! |
This commit updates the docs with changes that were made to wikis (Including GSoC 2019 Reports, Roadmap and new How-To's). Also adds more help on printing scan result to stdout.