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

Docs Update - Add SBOM page and updates to SBOM docs #1595

Closed
Madeline-UX opened this issue Apr 13, 2023 · 3 comments · Fixed by #1688
Closed

Docs Update - Add SBOM page and updates to SBOM docs #1595

Madeline-UX opened this issue Apr 13, 2023 · 3 comments · Fixed by #1688
Assignees
Labels
documentation 📘 Improvements or additions to documentation

Comments

@Madeline-UX
Copy link
Contributor

Madeline-UX commented Apr 13, 2023

Current

Is your feature request related to a problem? Please describe.

Information about SBOM is on the SBOM UI Page. This seems misplaced and like it should be up somewhere in the "Package Create" section. There is much more to the SBOM than just viewing it on deployment. The current SBOM UI page describes what SBOM is in detail instead of just focusing on the SBOM UI features.

Describe the solution you'd like

Docs page for all information on SBOMs in Zarf - under package create

  • single source of SBOM information
  • Tool used to generate
  • Structure/file type supported (security compliance)
  • Security reference/compliance
  • How to use/import to other tools
  • How to save SBOM locally
  • How SBOM is updated
  • link to SBOM UI page (UI Section)
  • Links to SBOM commands pages (CLI commands section)

Additional context

image

@Madeline-UX Madeline-UX added documentation 📘 Improvements or additions to documentation sbom labels Apr 13, 2023
@Madeline-UX Madeline-UX added this to the v0.26.1 milestone Apr 13, 2023
@github-project-automation github-project-automation bot moved this to New Requests in Zarf Project Board Apr 13, 2023
@Madeline-UX
Copy link
Contributor Author

@Racer159 Interested in your thoughts on this, given your work on the SBOM tools

@Madeline-UX Madeline-UX moved this from New Requests to Backlog in Zarf Project Board Apr 13, 2023
@Madeline-UX Madeline-UX changed the title Docs Update Docs Update - Add SBOM page and updates to SBOM docs Apr 17, 2023
@Racer159 Racer159 modified the milestones: v0.26 (m2), v0.27 (m1) Apr 20, 2023
@Racer159
Copy link
Contributor

Racer159 commented May 4, 2023

Steps:

  • UI Dashboards moved under deploy a zarf package
    • Add a section that covers zarf tools sbom convert in the inspect part
    • Rename SBOM Dashboard -> View SBOMs
  • New SBOM page under create a zarf package
    • Covers what is SBOM'ed
    • Covers the tool used to SBOM (Syft)
  • Update Overview and README links for above feature split

@Racer159
Copy link
Contributor

Racer159 commented May 9, 2023

These could be tied together as well: #1387

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants