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]: NEW tutorial, "How to validate code messages/events with AsyncAPI" #881

Closed
1 task done
starlightknown opened this issue Jul 20, 2022 · 2 comments · Fixed by #1061
Closed
1 task done
Assignees
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs gsod This label should be used for issues or discussions related to ideas for Google Season of Docs stale

Comments

@starlightknown
Copy link
Contributor

starlightknown commented Jul 20, 2022

What Dev Docs changes are you proposing?

Write NEW tutorial: "How to validate code messages/events with AsyncAPI"

NEW agnostic tutorials outline template
Introduction
In this AsyncAPI tutorial, we're going to learn how to validate code messages/events with AsyncAPI.

Background context
(add info on technologies used and why it matters)

Installation guide
Before you proceed to the next stage, you'll need to download a few things:

Install Node.js (v15 or newer).
Install Git on your Operating System (OS):
Install Git on MacOs
Install Git on Windows
Install Git on Linux
Tutorial step 1
In this step, we will...

Tutorial step 2
In this step, we will...

Tutorial step 3
In this step, we will...

Summary:
In this tutorial, we built...

Next steps:
Now that you've completed this tutorial, why don't you check out how to do ABC with our ABC tutorial? You may also want to check out the XYZ tutorial to learn how to XYZ.

Notes

    • example implementation of message validation
    • validation with AsyncAPI tools
      [ app \ asyncapi-validator ] <- message
      [ app \ mix of AsyncAPI Parser and AJV because of schemaFormat ] <- message
      [ app ] <- [ event gateway ] <- message
    • writing custom validator without AsyncAPI tools
      parse different schemaFormat -> into one schema format

Code of Conduct

  • I agree to follow this project's Code of Conduct
@alequetzalli alequetzalli added area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Jul 25, 2022
@alequetzalli alequetzalli added this to In progress 😀👍🏽 in AsyncAPI Docs Board Jul 25, 2022
@alequetzalli alequetzalli changed the title [📑 Docs]: NEW tutorial, Validation of Messages/Events in runtime [📑 Docs]: NEW tutorial, "How to validate code messages/events with AsyncAPI" Oct 8, 2022
@alequetzalli
Copy link
Member

heyooo @starlightknown, we're going to update the Streetlights tutorial by converting it into 4 separate NEW tutorials:

  • create AsyncAPI document
  • validate AsyncAPI document
  • generate code
  • validate code messages/events

From the above list, I am going to assign you @starlightknown the following tutorials:

  • validate AsyncAPI document
  • validate code messages/events

😄✌🏽

@github-actions
Copy link

github-actions bot commented Feb 6, 2023

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

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 gsod This label should be used for issues or discussions related to ideas for Google Season of Docs stale
Projects
Status: Done 🚀
AsyncAPI Docs Board
  
In progress 😀👍🏽
Development

Successfully merging a pull request may close this issue.

2 participants