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.

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

Improve examples #1031

Open
DennisClark opened this issue Apr 12, 2018 · 5 comments
Open

Improve examples #1031

DennisClark opened this issue Apr 12, 2018 · 5 comments
Assignees

Comments

@DennisClark
Copy link
Member

Using scancode-toolkit-2.9.1 I have discovered that
./scancode --examples
presents a bunch of examples that simply don’t work due to the changes in the command line syntax. New examples are needed please.

Related to #982

@pombredanne
Copy link
Member

Actually we had discussed to unbundle examples from the scancode repo proper with #1286
@DennisClark @mjherzog no objections?

@AyanSinhaMahapatra what would be the impact on the doc if we move the examples outside in a new repo?

@mjherzog
Copy link
Member

I think that we should unbundle them and recommend that we use examples from a few smaller OSS projects - much more realistic.

@AyanSinhaMahapatra
Copy link
Member

AyanSinhaMahapatra commented Nov 2, 2019

As we discussed in this comment, this would be great in the sense sample scans would be much more informative about the various Scancode options, given that we have better examples.

Currently, a lot of Scan Examples used to demonstrate scancode capabilities use the /samples folder as scan input (mentioned that it is distributed with the software and in the repository). The impact on documentation would be just to change these specific documentation lines to link to the other repository containing the new samples.

My suggestion on how the new samples should be -

  • Should Contain this present samples folder. It's perfect for understanding simpler Scancode capabilities.
  • Multiple Samples, of different sizes.
  • Include some scan results files, so they don't have to run the scan to test visualization. I.e. include .json and .sqlite files for these multiple samples, with what scan command was used to generate them.

@steven-esser
Copy link
Contributor

@AyanSinhaMahapatra We do have this repository: https://github.com/nexB/aboutcode-example-code

We could re-name this or create a new repo with similar structure. There are some packages in there that could be re-used for the new samples directory.

@s4-2
Copy link

s4-2 commented Mar 11, 2021

If I am allowed to work on this issue, I would like to fix this.

@pombredanne pombredanne changed the title Improve examples before v3 Improve examples Apr 1, 2021
@pombredanne pombredanne removed this from the v3.2 milestone Sep 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants