Improve examples  #1031

Activity

1. DennisClark

   added

   documentation

   Priority: high

   on Apr 12, 2018
2. DennisClark

   assigned

   pombredanne

   on Apr 12, 2018
3. pombredanne

   added this to the v3.0 milestone on Nov 5, 2018
4. pombredanne

   removed

   Priority: high

   on Nov 12, 2018
5. pombredanne

   modified the milestones: v3.0, v3.1 Documentation, documentation, documentation on Feb 16, 2019
6. pombredanne commented on Oct 23, 2019

   

   pombredanne

   on Oct 23, 2019

   Member

   More actions

   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?
7. mjherzog commented on Oct 23, 2019

   

   mjherzog

   on Oct 23, 2019

   Member

   More actions

   I think that we should unbundle them and recommend that we use examples from a few smaller OSS projects - much more realistic.
8. AyanSinhaMahapatra commented on Nov 2, 2019

   

   AyanSinhaMahapatra

   on Nov 2, 2019

   Last edited by AyanSinhaMahapatra

   Member

   More actions

   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.
9. steven-esser commented on Nov 20, 2019

   

   steven-esser

   on Nov 20, 2019

   Contributor

   More actions

   @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.
10. s4-2 commented on Mar 11, 2021

    

    s4-2

    on Mar 11, 2021

    More actions

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

    changed the title [-]Improve `examples` before v3 [/-] [+]Improve `examples` [/+] on Apr 1, 2021
12. pombredanne

    removed this from the v3.2 milestone on Sep 24, 2021
13. chinyeungli commented on Jul 2, 2025

    

    chinyeungli

    on Jul 2, 2025

    Contributor

    More actions

    what's the status of this? I am still able to see the samples when I run ./scancode --examples
14. chinyeungli

    added

    Priority: medium

    on Jul 2, 2025