Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[📑 Docs]: Adapt Streetlights - Interactive tutorial for v3 #1863

Closed
4 tasks done
jonaslagoni opened this issue Jun 28, 2023 · 12 comments
Closed
4 tasks done

[📑 Docs]: Adapt Streetlights - Interactive tutorial for v3 #1863

jonaslagoni opened this issue Jun 28, 2023 · 12 comments
Assignees
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers stale

Comments

@jonaslagoni
Copy link
Member

jonaslagoni commented Jun 28, 2023

For AsyncAPI v3, we need to adapt the streetlights interactive tutorial (https://www.asyncapi.com/docs/tutorials/streetlights-interactive) to be usable with AsyncAPI v3.

Make sure you base your change on the next-major-spec branch and target it in your PR 🙂 If you have any questions, don't hesitate to ask.


TASKS

We need to replace this old content with the new 4 tutorials we made last year, making them interactive:

@jonaslagoni
Copy link
Member Author

@alequetzalli I have no idea what tasks are needed to achieve this and to mark this as a good first issue, can you help pinpoint that?

@derberg
Copy link
Member

derberg commented Jun 28, 2023

this is the topic I mentioned on the call. Must have is migration of nodejs template 🤷🏼 or as @fmvilas mentioned on the call (while selling his idea that code generation is bad) it can be modified to use glee (once migrated)

tbh, the best if we have 2 tutorials, that show code generation scenario, and asyncapi-as-config scenario 🤷🏼

one of my mentorship ideas is rewrite nodejs templates to react enginee, and during the works I want to push for adding v3 support during rewrite. I will make sure first rewrite will happen to the nodejs template used in the tutorial

@jonaslagoni
Copy link
Member Author

Is there anything that can be done in parallel, or is this issue blocked by asyncapi/nodejs-template#215?

Copy link
Member

derberg commented Jun 28, 2023

well, in parallel maybe somebody could work on glee version of the tutorial maybe 🤔

Copy link
Member

quetzalliwrites commented Jun 29, 2023

Quick reminder on staying within roadmap scope:

I don't think we should be focusing on adapting this outdated tutorial to V3 because this tutorial was always meant to be replaced by the 4 tutorials we made in 2022 GSoD. The plan was always to repurpose those 4 new tutorials into an interactive version to replace this interactive streetlights.

@asyncapi asyncapi deleted a comment from asyncapi-bot Jun 29, 2023
@asyncapi asyncapi deleted a comment from asyncapi-bot Jun 29, 2023
@quetzalliwrites
Copy link
Member

/good-first-issue area/docs

@asyncapi-bot
Copy link
Contributor

Hey @alequetzalli, your message doesn't follow the requirements, you can try /help.

@quetzalliwrites quetzalliwrites added good first issue Good for newcomers 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Jun 29, 2023
@quetzalliwrites
Copy link
Member

I fail at botting 😂

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Jun 29, 2023

@alequetzalli I have no idea what tasks are needed to achieve this and to mark this as a good first issue, can you help pinpoint that?

@jonaslagoni Yes! We need to replace this old content with the new 4 tutorials we made last year, making them interactive:

  1. Create an AsyncAPi document: https://www.asyncapi.com/docs/tutorials/create-asyncapi-document
  2. Generate code: https://www.asyncapi.com/docs/tutorials/generate-code
  3. Validate document (with Studio): https://www.asyncapi.com/docs/tutorials/studio-document-validation
  4. Validate messages: https://www.asyncapi.com/docs/tutorials/message-validation

I have updated your description in THIS issue and have created the required 4 subtasks.

Copy link
Member

derberg commented Jun 29, 2023

@alequetzalli you just say docs not area/docs when you talk to the bot

@github-actions
Copy link

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 ❤️

@derberg
Copy link
Member

derberg commented Dec 4, 2023

done and merged

@derberg derberg closed this as completed Dec 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers stale
Projects
Status: Changes proposed 📄
Development

No branches or pull requests

4 participants