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

Create glossary #244

Open
smythp opened this issue Aug 29, 2023 · 1 comment
Open

Create glossary #244

smythp opened this issue Aug 29, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@smythp
Copy link
Collaborator

smythp commented Aug 29, 2023

Background

As there are a lot of specialized terms used throughout the Sigstore docs, a glossary may be useful, especially for new users.

Work Plan

Hugo has functionality for taxonomies and terms that may be useful for this purpose, but they may be better suited for tagging and categorization. I'll look into the correct Hugo structure, whether it be a data structure or a markup-based structure. I'll also create an initial small glossary with some frequently used terms.

Notes

I tend to try to make display structures simple on sites like this for accessibility and maintainability reasons, but I'll also consider if there are other ways to display glossary info. (Probably not pop-up, hover, or JS-heavy operations).

References #243

@smythp smythp added the enhancement New feature or request label Aug 29, 2023
@haydentherapper
Copy link
Contributor

One particular term is "bundle" - It's become overloaded in both Sigstore and the SSCI space. Going forward, we want "bundle" to refer to https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto - The collection of verification material to verify a single signature. Previous definitions included the output from Rekor or from Cosign. in-toto has its own definition too - https://github.com/in-toto/attestation/blob/main/spec/v1/bundle.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants