Where should GSD documentation be kept? - Githubissues

CloudSecurityAlliance / gsd-tools

Global Security Database Tools

https://gsd.id

Apache License 2.0

41 stars 20 forks source link

Where should GSD documentation be kept? #136

Closed joshbuker closed 1 year ago

joshbuker commented 1 year ago

We have a couple of options for where to store various documentation (e.g., Policy documents #3):

GitHub Wiki(s) (https://github.com/cloudsecurityalliance/gsd-tools/wiki)
gsd.id website (https://github.com/cloudsecurityalliance/gsd-tools/tree/main/website)
README.md files within gsd-tools (https://github.com/cloudsecurityalliance/gsd-tools/blob/main/CONTRIBUTING.md)
Some other option?

What would be the easiest to use for folks and provide the best experience for those coming into the project?

Personally, I feel that using the gsd.id website and PRs to update would be a good balance between ease of updating and usability.