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

Improve/add documentation #8

Closed
pombredanne opened this issue Sep 15, 2020 · 0 comments
Closed

Improve/add documentation #8

pombredanne opened this issue Sep 15, 2020 · 0 comments

Comments

@pombredanne
Copy link
Member

pombredanne commented Sep 15, 2020 •
edited by mjherzog
Loading

The documentation we have is sparse. We would need:

  • a basic and descriptive README that explain what this is
  • installation documentation
  • usage documentation
  • scanpipe pipelines tutorials and documentation
pombredanne added a commit that referenced this issue Sep 18, 2020
@pombredanne
Add new intro and concept documentation #8
9f14dab 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Sep 18, 2020
@pombredanne
Add new tutorial documentation #8
f1f8d63 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Sep 18, 2020
@pombredanne
Add new minimal command line documentation #8
f7e3585 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Sep 18, 2020
@pombredanne
Add new intro and concept documentation #8
0e61628 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Sep 18, 2020
@pombredanne
Add new tutorial documentation #8
665217d 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Sep 18, 2020
@pombredanne
Add new minimal command line documentation #8
a5e9342 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Sep 18, 2020
@pombredanne
Add new minimal documentation #8
b67b96f 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Sep 18, 2020
@pombredanne
Add new minimal documentation #8
172d177 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added a commit that referenced this issue Sep 18, 2020
@pombredanne
Merge pull request #15 from nexB/8-documentation
97c626d 
Add minimal documentation #8
tdruez added a commit that referenced this issue Sep 18, 2020
@tdruez
Fix typos and formatting in documentation #8
c5a739a 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 18, 2020
@tdruez
Split dev installation and offline installation docs #8
2923659 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 18, 2020
@tdruez
Add a output results section in tutorial 1 #8
0f6d25a 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 18, 2020
@tdruez @pombredanne
Add scanpipe management commands with documentation #13 #8
4d8722d 
* List the generated graph files in the printed output #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Add a createproject management command #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Add scanpipe as a cli entry point #13

Aliased to the same code as in manage.py

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Add more unit test for the project management command #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Complete unit test for the createproject management command #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Add run, add-input, and add-pipeline management commands #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Fix failing unit test #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Add output management command using the ResultsGenerator #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Simplify the output command arguments #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Add unit tests for the add-input and add-pipeline commands #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Add new minimal documentation #8

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typos and formatting in documentation #8

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Add show-pipeline management command #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Add unit test for the run management command #13

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Split dev installation and offline installation docs #8

Signed-off-by: Thomas Druez <tdruez@nexb.com>

* Add a output results section in tutorial 1 #8

Signed-off-by: Thomas Druez <tdruez@nexb.com>

Co-authored-by: Philippe Ombredanne <pombredanne@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Add base conf and index for building the documentation #8
f1db9b1 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Move the changelog file to the root #8
eac4f63 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
First round of documentation formatting for publication #8
3b16ff9 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Second round of documentation formatting for publication #8
1c45182 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Third round of documentation formatting for publication #8
82eb305 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Simplify README and include link to the documentation #8
679c8b8 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Set master_doc to index in the documentation conf #8
cf62294 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Fix typos in the documentation #8
e109395 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Refine the documentation navigation #8
28dbe04 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Take the database host from a SCANCODEIO_DB_HOST env variable #8
5635061 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Improve test_scanpipe_management_command_graph to support both cases #8
7a7f6cc 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez
Add references to Django, ScanCode, and Metaflow #8
05888bf 
Signed-off-by: Thomas Druez <tdruez@nexb.com>
tdruez added a commit that referenced this issue Sep 21, 2020
@tdruez @pombredanne
Documentation #8 (#16)
03e7a3c 
Signed-off-by: Thomas Druez <tdruez@nexb.com>

Co-authored-by: Philippe Ombredanne <pombredanne@nexb.com>
@tdruez tdruez closed this as completed Sep 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tdruez @pombredanne