Closed terriko closed 1 year ago
Please assign me this issue I want to contribute.
@Swarnlataaa have fun! Let us know if you have any questions.
This wasn't completed in earlier hackathons so I'm putting it up for hacktoberfest folk to try!
Short tips for new contributors:
Claiming issues:
Hi @terriko can you please provide context it like where we can add the guide and if there is any specific format for it? Thanks!
@kishan3 We've got a bunch of how-to guides in this directory if you want to see how the others are done: https://github.com/intel/cve-bin-tool/tree/main/doc/how_to_guides
The format would be markdown (although we can handle RestructuredText too, most of our stuff is in markdown) and you can put it in that same how_to_guides
directory. You probably want to add it to the index (https://github.com/intel/cve-bin-tool/blob/main/doc/how_to_guides/index.rst) so that it'll get linked correctly when the docs are built.
Thanks @terriko there is already doc https://github.com/intel/cve-bin-tool/blob/main/doc/how_to_guides/sbom_generation.md Not sure what we need to add to it.
Hm, maybe this should have been closed already? But since it wasn't, let's get the sbom creation guide linked into the user manual (doc/MANUAL.md) and potentially the README.md file so it's easier to find, and then we'll declare this closed.
@kishan3 and if you're looking for something else docs-y to do, there's also an open issue for a triage how-to: https://github.com/intel/cve-bin-tool/issues/3219
Okay, going to close this one as good enough for now.
Thanks, @terriko unfortunately I couldn't check the other one.
We recently added the ability to do sbom generation in cve-bin-tool. It's not super fancy yet, but it might be nice to have a guide for how to use it with examples and tips.
Edit: this was an issue flagged for hackathon participants that never got claimed; it's open to non-hackathon contributors now.