[Docs] Milestones for Creating Tutorial Documentation Guides for Glee

[afzal442]

• Related to Proposal for having a tutorial document or separate guides for glee.  #431

Milestone 1: Topic Preparation

• Compile a list of important topics related to Glee.
• Identify areas that require guidance from mentors.
• Seek feedback and approval from mentors on the topic list.

Milestone 2: Brainstorm

• Brainstorm and discuss the structure of the tutorial documentation with mentors.
• Create a clear and comprehensive overview page for the documentation.
• Outline step-by-step instructions for installation and project setup.

Milestone 3: Documentation

• Develop separate sections or guides for each feature of Glee.
• Explain the purpose, usage, and customization options for each feature.
• Incorporate feedback from mentors to improve the documentation.

Milestone 4: Code Examples and Best Practices

• Provide practical code examples to demonstrate the usage of Glee's features.
• Incorporate best practices and guidelines for effective utilization of Glee.
• Review and refine code examples based on feedback from mentors.

Milestone 5: Auto Deployment Guide

• Create a comprehensive guide for deploying Glee.
• Cover different deployment options and hosting considerations.
• Document specific steps or configurations required for deployment.

Milestone 6: Interactive Tutorials

• Develop interactive tutorials using platforms like Killercoda.
• Allow users to experiment with Glee directly within the documentation.
• Ensure a hands-on approach for enhanced learning.

Milestone 7: Community Engagement

• Encourage the Glee user community to contribute to the documentation.
• Set up a process for accepting and reviewing contributions.
• Regularly update the documentation based on community submissions.

Milestone 8: Documentation Release and Maintenance

• Finalize and publish the tutorial documentation or separate guides
• Make the documentation available on the Glee website or relevant platforms
• Establish a process for ongoing maintenance and updates to keep the documentation current and relevant

Scope

• Milestone 1: Topic Preparation
• Milestone 2: Brainstorm
• Milestone 3: Documentation
• Milestone 4: Code Examples and Best Practices
• Milestone 5: Auto Deployment Guide
• Milestone 6: Interactive Tutorials
• Milestone 7: Community Engagement
• Milestone 8: Documentation Release and Maintenance

Note: The milestones mentioned above are provided as a general guideline. The specific milestones and their implementation may vary based on the complexity of Glee, the availability of resources, and the project's requirements.

@Souvikns @KhudaDad414

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[fmvilas]

FYI @afzal442 opened two draft PRs for intro and installation guides, and the getting started guide:

• docs: adds an installation guide #479
• docs: adds getting started guide #483

[Souvikns]

@afzal442 I think we can close this now as we achieved what we planned.

[afzal442]

Right. I am closing this. Thanks for the kind supports. @Souvikns @KhudaDad414 🚀