- Describe YOUR_TOPIC.
- Include an architecture diagram for deeper understanding.
- Provide a link to the official documentation for YOUR_TOPIC.
- Highlight any essential prerequisites necessary for understanding YOUR_TOPIC.
- For instance, in the context of Kubernetes, prior knowledge of Docker might be required for comprehending containerization technology.
- Share installation steps or provide a link to detailed installation documentation.
- Consider including instructions for both local and production environments.
- To get started visit topics/<YOUR_TOPIC>/basic (Checkout the TOPIC_STRUCTURE.md to create the topic directory structure)
-
To get more advanced examples/hands on visit topics/<YOUR_TOPIC>/advanced (Checkout the TOPIC_STRUCTURE.md to create the topic directory structure)
-
Link to official advanced examples (if any)
- Offer an official cheatsheet link or create one for quick reference to features and functionalities.
- Suggest quality reads related to YOUR_TOPIC for further learning and understanding.