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

Inclusion of Glossary in the spec document? #956

Open
bact opened this issue May 3, 2024 · 1 comment
Open

Inclusion of Glossary in the spec document? #956

bact opened this issue May 3, 2024 · 1 comment

Comments

@bact
Copy link
Contributor

bact commented May 3, 2024

Currently the Glossary of Terms is available at the model development repo

Should we consider to include this into a more visible place to the general audience?

For example, as an annex of the spec doc published on https://spdx.github.io/spdx-spec/v3.0/

There can be at least two ways to do this:

  1. Permanently move the Glossary.md from spec-3-model repo to somewhere inside the docs/ directory of spdx-spec repo (and renamed it to glossary.md to be consistent with other files)
    • Future edits of the Glossary will happen in spdx-spec repo (change from now)
  2. Dynamically copy the Glossary.md from spec-3-model repo to somewhere inside the docs/ directory of spdx-spec repo everytime there's a doc generation (and renamed it to glossary.md to be consistent with other files)
    • Future edits of the Glossary will happen in spdx-3-model repo (same as now)
    • Need modification in .github/workflows/publish_v3.yml and probably a script for local test
@zvr
Copy link
Member

zvr commented May 3, 2024

I think the glossary is more about the model and I'm not sure it belongs in the spec.

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

No branches or pull requests

2 participants