asyncapi / studio

Visually design your AsyncAPI files and event-driven architecture.
https://studio.asyncapi.com
Apache License 2.0
171 stars 99 forks source link

Create onboarding for features of Studio #284

Closed mcturco closed 1 month ago

mcturco commented 2 years ago

Reason/Context

I think the Studio could use an onboarding process where there are a few steps for new users to go through to get started in Studio, especially if coming from Playground. I think it could be a modal with 3-5 simple steps to getting started, perhaps explaining that you can start from a template, show the visualizer, etc. I think we could also use highlighting at each step in the area where the user would take an action.

I don't feel like this is a super urgent thing to work on, but thought of it when reviewing PR #282 where I was thinking of ways that we could reduce the amount of text content in the "New features" modal.

Some examples for inspiration:

aialok commented 4 months ago

Should I go with this implementation? I have few question to start with : )

Thank you @KhudaDad414

Shurtu-gal commented 4 months ago

@jerensl I am assigning this issue to @aialok as he approached first and had a better implementation idea as well.

aeworxet commented 4 months ago

Bounty Issue's Timeline

Complexity Level Assignment Date (by GitHub) Start Date (by BP Rules) End Date (by BP Rules) Draft PR Submission Final PR Merge Start Final PR Merge End
Medium 2024-06-21 2024-07-01 2024-08-11 2024-07-14 2024-07-28 2024-08-11
Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.
Keep in mind the responsibility for violations of the Timeline.
aialok commented 4 months ago

Hey team : ) I have discussed with @Shurtu-gal on slack about the steps to add :

Is there anything missing? or this is too much please provide your feedback on this. Also what should be styling of card like color, font etc?

Regarding the user who have visited first time or not. I am planning to use local-storage method.

Thank you : )

Shurtu-gal commented 4 months ago

We can store it in both local storage as well as cookies just for safety. Don't want to annoy users. Furthermore, some more things from the top of my mind:

  1. Have a button in settings or some other place so that user can view tutorial anytime he wants.
  2. Have a skip feature for people who already know it.
aialok commented 4 months ago

We can store it in both local storage as well as cookies just for safety. Don't want to annoy users. Furthermore, some more things from the top of my mind:

  1. Have a button in settings or some other place so that user can view tutorial anytime he wants.
  2. Have a skip feature for people who already know it.

Sure, I will take care of these things.

Thank you : )

aeworxet commented 2 months ago

PR https://github.com/asyncapi/studio/pull/1120 that resolves this Bounty Issue was ready to merge on 2024-08-09, but it is still waiting for the final review.

Shurtu-gal commented 2 months ago

Just need a final review from @Amzani and disabling of SonarCloud check and we are good to go.

Shurtu-gal commented 1 month ago

@aeworxet This bounty issue has been completed by @aialok.

aeworxet commented 1 month ago

Response, critical for technical resolution of this Bounty Issue (final PR merge) was delayed for six periods of three consecutive working days https://github.com/asyncapi/studio/pull/1120#issuecomment-2278235403 https://github.com/asyncapi/studio/pull/1120#issuecomment-2368162922

so all remaining target dates of the Bounty Issue's Timeline are extended by seven calendar weeks.

Bounty Issue's Timeline Extended

Complexity Level Assignment Date (by GitHub) Start Date (by BP Rules) End Date (by BP Rules) Draft PR Submission Final PR Merge Start Final PR Merge End
Medium 2024-06-21 2024-07-01 2024-09-29 2024-07-14 2024-07-28 2024-09-29
Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.
Keep in mind the responsibility for violations of the Timeline.
aeworxet commented 1 month ago

Bounty Issue Is Completed 🎉

@aialok, please go to the AsyncAPI page on Open Collective and submit an invoice for USD 200.00 with the expense title Bounty studio#284, tag bounty, and full URL of this Bounty Issue in the description.