-
Notifications
You must be signed in to change notification settings - Fork 26
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
Add a simple FAQ #75
Add a simple FAQ #75
Conversation
Signed-off-by: Josh Bressers <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! Two nits to pick, but nothing major.
FAQ.md
Outdated
# SBOM Everywhere Catalog FAQ | ||
|
||
## What is the SBOM Catalog? | ||
The OpenSSF has a working group called “SBOM Everywhere”, one of the projects this group is working on is a place to catalog as much SBOM related information as possible. Because the OpenSSF has a focus on open source, we’re doing it as an open source project! The goal is to capture anything that’s SBOM related and make it easy to find. Projects, documents, standards, working groups, anything that could be useful. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add link to SBOM Everywhere project page, maybe?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes sense. I added a link
We are trying to capture and track as much information about the SBOM ecosystem we can. Meetings, projects, tools, formats, standards, everything. If you’re unsure, let’s chat about it, you can find our details here https://sbom-catalog.openssf.org/about-us.html | ||
|
||
## How can I add an entry or fix an error to the Catalog or Wiki? | ||
Open an issue in GitHub https://github.com/ossf/sbom-everywhere/issues |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Strictly speaking, an issue tracker isn't a way to edit a wiki. How about linking to the place where the wiki can be edited? Or don't call it a wiki. 😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm OK calling it a wiki. We edit it via PRs in this instance, but we don't have the PR instructions ready yet
I agree with sjn's comments, but otherwise this looks good. I wouldn't object to merging as-is and making refinements later, either. |
Signed-off-by: Josh Bressers <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. (I don't have write access on this repo, so my review doesn't "count", but...)
No description provided.