OWASP / owasp-masvs

The OWASP MASVS (Mobile Application Security Verification Standard) is the industry standard for mobile app security.
https://mas.owasp.org/
Creative Commons Attribution Share Alike 4.0 International
1.98k stars 423 forks source link

Double glossary versions #464

Closed commjoen closed 1 week ago

commjoen commented 4 years ago

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 commented 4 years ago

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

commjoen commented 4 years ago

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.