spdx-spec
spdx-spec copied to clipboard
Inclusion of Glossary in the spec document?
Currently the Glossary of Terms is available at the model development repo
- https://github.com/spdx/spdx-3-model/blob/main/Glossary.md
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:
- Permanently move the
Glossary.mdfromspec-3-modelrepo to somewhere inside thedocs/directory ofspdx-specrepo (and renamed it toglossary.mdto be consistent with other files)- Future edits of the Glossary will happen in
spdx-specrepo (change from now)
- Future edits of the Glossary will happen in
- Dynamically copy the
Glossary.mdfromspec-3-modelrepo to somewhere inside thedocs/directory ofspdx-specrepo everytime there's a doc generation (and renamed it toglossary.mdto be consistent with other files)- Future edits of the Glossary will happen in
spdx-3-modelrepo (same as now) - Need modification in
.github/workflows/publish_v3.ymland probably a script for local test
- Future edits of the Glossary will happen in
I think the glossary is more about the model and I'm not sure it belongs in the spec.
Closing this based on discussion. Please reopen if you disagree.