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

Craft better documentation for tutorials that use a Docker installation #440

Closed
pombredanne opened this issue May 25, 2022 · 5 comments
Closed

Craft better documentation for tutorials that use a Docker installation #440

pombredanne opened this issue May 25, 2022 · 5 comments
Assignees
@tdruez
Labels
documentation Improvements or additions to documentation

Comments

@pombredanne
Copy link
Contributor

Today all the tutorials (and in particular the "create pipeline from the command line" tutorials such as https://scancodeio.readthedocs.io/en/latest/tutorial_cli_analyze_docker_image.html) are assuming a virtualenv and development style checkout and installation.

They do not work well with a Docker -based deployment that we otherwise recommend.
The only place that provides some input on command line project creation with a Docker deployment is in https://scancodeio.readthedocs.io/en/latest/command-line-interface.html?highlight=volume#command-line-interface

I would like to have a simple step by step tutorial for creating a scan project from the command line using a Docker deployment.
@pombredanne pombredanne added the documentation Improvements or additions to documentation label May 25, 2022
@daredevil3435
Copy link

@pombredanne can you explain more? I would like to work on this

@tdruez
Copy link
Contributor

tdruez commented Feb 23, 2023

@daredevil3435 I already have a patch for this ready, it just need a bit of cleanup. Please find another issue to work on ;)

@tdruez tdruez self-assigned this Feb 23, 2023
@daredevil3435
Copy link

@daredevil3435 I already have a patch for this ready, it just need a bit of cleanup. Please find another issue to work on ;)

Ok ok that's fine

tdruez added a commit that referenced this issue Feb 28, 2023
@tdruez
Add --print option to the output scanpipe command #440
3440a6f 
Signed-off-by: Thomas Druez <[email protected]>
@tdruez
Copy link
Contributor

tdruez commented Feb 28, 2023

See also #362

tdruez added a commit that referenced this issue Feb 28, 2023
@tdruez
Rewrite the Analyze Codebase CLI tutorial for a Docker setup #440
6939b89 
Signed-off-by: Thomas Druez <[email protected]>
@tdruez tdruez mentioned this issue Mar 3, 2023
Closed
tdruez added a commit that referenced this issue Mar 13, 2023
@tdruez
Rewrite the Analyze Docker Image CLI tutorial for a Docker setup #440
31fb337 
Signed-off-by: Thomas Druez <[email protected]>
tdruez added a commit that referenced this issue Mar 13, 2023
@tdruez
Rewrite the CLI tutorials for a Docker-based installation #440 (#633)
679d8b6 
* Add --print option to the output scanpipe command #440

Signed-off-by: Thomas Druez <[email protected]>

* Rewrite the Analyze Codebase CLI tutorial for a Docker setup #440

Signed-off-by: Thomas Druez <[email protected]>

* Rewrite the Analyze Docker Image CLI tutorial for a Docker setup #440

Signed-off-by: Thomas Druez <[email protected]>
@tdruez
Copy link
Contributor

tdruez commented Mar 13, 2023

Done in #633

@tdruez tdruez closed this as completed Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tdruez tdruez

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tdruez @pombredanne @daredevil3435