Content Guidelines
It's great that you want to contribute content! ✍
Since everything written on this site is freely available on the Internet, it's important to follow some simple rules and guidelines for content.
Language and Style
The content on these pages is primarily for technicians, so technical language is to be expected. However, if terms are used that cannot be assumed to be well known, they must be explained. The language should be readable and understandable by most technicians, not just those who have worked with security for decades!
Remember that all articles should have an introduction that can be read and understood by everyone from managers and delivery organizations to security experts and junior developers.
Article Structure
All articles should have the following structure:
---
sidebar_position: N
title: Concise Title
---
# Concise Title
:::tip[Brief Summary]
A brief summary of the topic - maximum 1-2 sentences.
:::
The introduction should be summarizing and use language that can be read and understood by everyone.
# Main Text
All articles should be technology-agnostic.
Feel free to use specific technology in examples, but avoid articles that only make sense on Azure or AWS.
Use features in MD / Docusaurus to emphasize or highlight important points.
Use code fencing to show examples and break up the content with headings (no one likes a wall of text).
# Further Reading
* [Eksternal link 1](URL)
* [Eksternal link 2](URL)
External Links
Use permalinks where possible. The purpose of the Further Reading section is to point to resources with more in-depth content so that it is possible to delve further into a topic after getting a taste from an article.
If you use text from another article or source, it must be referenced.
Help!
Need help with Markdown?
Any questions about content, what you can contribute, etc.? Contact us on Slack or see this issue