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

Double glossary versions #464

Open
commjoen opened this issue Jul 9, 2020 · 2 comments
Open

Double glossary versions #464

commjoen opened this issue Jul 9, 2020 · 2 comments

Comments

@commjoen
Copy link
Collaborator

commjoen commented Jul 9, 2020

QUESTION: Is there a reason why the MASVS has 2 glossaries (even differently formatted) :thinking_face: ?
https://github.com/OWASP/owasp-masvs/blob/master/Document/0x90-Appendix-A_Glossary.md
https://github.com/OWASP/owasp-masvs/blob/master/Document/GLOSSARY.md

  1. 0x90-Appendix-A_Glossary.md is only references in README
  2. GLOSSARY.md is referenced everywhere else.

Actions to take:
use 1, remove 2 and make sure that references are referenced to 1.

@commjoen
Copy link
Collaborator Author

commjoen commented Jul 9, 2020

Update: gitbook requires a different format of the glossary, whereas the title based glossary works best for the document pipeline.

@commjoen
Copy link
Collaborator Author

commjoen commented Jul 9, 2020

Actions to take:

  1. test whether gitbook still shows proper references to the glossary terms
  2. test whether the new pipeline is able to have glossary links
  3. if both 1 and 2 are a "no", just follow the actions, 1 is no or 2 is a no: update the references to both documents accordingly, but do make sure we generate one from the other.

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

1 participant