This is the git repository containing the source for https://secwiki.cloud, a cloud security knowledge base curated by the cloud security team at WithSecure. Secwiki.cloud is intended to be an open cloud security knowledge base, covering both defensive and offensive topics across most common cloud platforms and cloud-adjacent tooling. It's been built following a set of core principles:
- Summarize and cite, don't compete - we credit/cite any existing research on a topic, and wherever possible, we reference content elsewhere rather than reinventing the wheel.
- Update little and often - it's often hard to find time to make substantial additions and improvements, but lots of little contributions add up fast
- Make it easy to consume and use - we bias towards easy-to-skim content formats, making extensive use of bullets, tables and other similar styles to break the content up and make it easier to find what you need quickly.
We welcome any and all positive contributions from everyone in the community, from small fixes and improvements to submissions for whole services. Before you contribute, there are a few things to be aware of:
- The contents of the repository are licensed under Apache 2.0, and your contributions will be too.
- We've put together a contribution guide to help keep the content consistent when people contribute significant changes. Please review this before submitting significant improvements.
- We expect contributors to follow the Code of Conduct when interacting with other users and repository maintainers in issues, merge requests and so on.
You do not need to be able to run the site locally to contribute to the repository. You can make edits and create new pages directly from GitHub. Simply browse to the file you'd like to edit, or the directory you'd like to add a new file to, and click "Add File" above the code browser. GitHub will then open the built-in Markdown editor, and you can submit your pull request from there. That said, if you are making significant changes, you may find it easier to validate your work locally before pushing, per the instructions below.
The wiki is built on Docusaurus. You'll need node and npm installed as prerequisites. Once you have node set up, to run the wiki locally:
git clone [email protected]:WithSecureLabs/cloud-wiki.gitnpm installnpm start
We maintain a list of content contributors on the home page. We do our best to update it periodically, but if you've made contributions and wish to be added to that list before we get to it, please just open another pull request and add your GitHub username and a Twitter handle, if you have one, to the table of contributors in the home page.