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

Add a simple FAQ #75

Merged
merged 2 commits into from
Sep 11, 2024
Merged

Add a simple FAQ #75

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0f84ce
Add a simple FAQ
joshbressers Sep 11, 2024
dbdae11
Add a link to SBOM Everywhere
joshbressers Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# 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.
Copy link
Contributor

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?

Copy link
Contributor Author

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


## How do I access and use the tool?
The SBOM catalog can be seen at https://sbom-catalog.openssf.org/ - It’s actually two tools, the Wiki and the catalog. The Wiki is to capture more static information like documents and standards. Our goal is to link to as many things as we can.

The Catalog is where we can add tooling with a variety of uses. You have the ability to filter results, view a list or a tree, arrange which filters to apply in which order. It’s a very interactive tool. There are a lot of tools and figuring out which tool does what you need is a challenge, we want to make it easier. It’s a read only website, feel free to push buttons and see what it can do. If something breaks, let us know!

## Who can update this?
Anyone can contribute to this. It’s open source! You can see all the details in our GitHub repo
https://github.com/ossf/sbom-everywhere

## What sort of information can we add?
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
Copy link
Contributor

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. 😅

Copy link
Contributor Author

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

We’re working on a nice contributing guide, but the issue is easiest right now. The guide is still a few weeks out probably.

## Is the catalog only for open-source projects?
We accept all tools, not only open-source tools. Feel free to open an issue if you’re unsure. We’re happy to discuss anything.

## What’s the license?
Contributions to the SBOM Catalog and Wiki should be considered under the Apache 2.0 open source license
Loading