Proposal for having a tutorial document or separate guides for glee.

[Souvikns]

Reason/Context

Currently, it is hard to get started with Glee as a new user, we need some kind of documentation that talks about:

• how to install and setup Glee
• achieve what we are trying to do (details on what tweaks we can make)
• how to deploy glee.

I think it would really benefit from having tutorial documentation for Glee so as to talk about different features Glee has and also as a user manual for new users to learn from, something like reactjs tutorial, or we can have a guides sections where we can have setup by setup guides for achieving certain things, and when we have new features we can create guides to showcase them.

We need to decide if it is something that would be beneficial, and if we decide on this, how should we go about it, should this be on the website or in the Readme, or on wikis?

Specific Goals

Just defining what we need to document

• We need to document a getting started guide where we help the user set up a glee project and help him get started with the project.
• Docs that talk about details on different features of glee, like what are different lifecycle events and how to use them, docs on config, etc.

pinging @fmvilas @KhudaDad414

[rukundob451]

@Souvikns, is this available to be worked on. I would like to work on it as a proposal for the mentorship?. Kindly tell me what you think, I will be glad for a positive response, thank you.

[rukundob451]

@Souvikns will be waiting in on your response, thank you.

[Souvikns]

@rukundob451 we are thinking of adding this issue to the mentorship program, nothing is final yet give us some time.

[rukundob451]

@rukundob451 we are thinking of adding this issue to the mentorship program, nothing is final yet give us some time.

I would surely want to be assigned this issues and work on it during the mentorship program.

[ConnectBhawna]

Hii @Souvikns I am interested in working in this issue.
Could you please assign this to me. Or firstly may i need to share my approach for the same

[Varshi4126]

@Souvikns, I am interested in this project.. can you guide me with the further steps..?
Should I attach my approach too..?

[rukundob451]

@Souvikns, I am interested in this project.. can you guide me with the further steps..? Should I attach my approach too..?

Feel free

[maveraw]

Hi @rukundob451, I am willing to contribute to glee, can you tell me where to submit proposal and do we need to contribute also??

[AceTheCreator]

Hey Folks,

To clarify how to submit a proposal, you should contact the project Mentor/s on Slack and send them your submission in the form of a document or ask them how best they'd prefer you submit your proposals.

[rukundob451]

Hey Folks,

To clarify how to submit a proposal, you should contact the project Mentor/s on Slack and send them your submission in the form of a document or ask them how best they'd prefer you submit your proposals.

Thank you for the communication @AceTheCreator.

[maveraw]

Hey Folks,

To clarify how to submit a proposal, you should contact the project Mentor/s on Slack and send them your submission in the form of a document or ask them how best they'd prefer you submit your proposals.

Thanku @AceTheCreator

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️