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: add content for module 4 #4

Open
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

mhmohona
Copy link
Contributor

@mhmohona mhmohona commented Nov 28, 2023


Module 4: Creating and Validating AsyncAPI Documents

Reaction: With the spaceship fixed, Eve looks forward to testing communication with Chan.

  • Writing and documenting AsyncAPI code from scratch.
  • Utilizing AsyncAPI tools for document validation.
  • Hands-on exercises for creating and validating AsyncAPI documents.

Related issue(s)
asyncapi/website#1520

@mhmohona mhmohona marked this pull request as draft November 28, 2023 09:50
@mhmohona mhmohona marked this pull request as ready for review November 29, 2023 06:44
@alequetzalli
Copy link
Member

Hey folks, so please update your planet names to:

  • Eve's planet: Capuccinova
  • Chan's planet: Brownieterra

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just one comment

to be honest killercoda tutorials is hard to review as there is no preview

I think technically accurate except of one comment I left

on to you @alequetzalli

100-level-AsyncAPI-Intro/step3.md Outdated Show resolved Hide resolved
@smoya
Copy link
Member

smoya commented Feb 19, 2024

@mhmohona I would like to get a clarified description of what this module wants to show because I don't see just a different approach on https://github.com/asyncapi/learning-paths/pull/9/files#r1494514714.

For example, it says nothing about generating code.

cc @alequetzalli

@alequetzalli
Copy link
Member

...I would like to get a clarified description of what this module wants to show because I don't see just a different approach on https://github.com/asyncapi/learning-paths/pull/9/files#r1494514714. For example, it says nothing about generating code.

Sergio, yes, thank you for bringing this problem to our attention! I agree. It was also my bad for not catching myself earlier. 😬 Please find learning path modules' outline below:


Module 1: Introduction to AsyncAPI

Scene: Chan's ship crash-lands in Eve's backyard, initiating their adventure with AsyncAPI.

  • What is AsyncAPI? An introduction to its purpose and capabilities.
  • Why use AsyncAPI? Exploring its benefits and applications.
  • Real-world use cases of AsyncAPI.

Module 2: Event-Driven Architectures

Reaction: Eve helps check Chan’s spaceship engine, introducing event-driven architectures.

  • Introduction to event-driven architectures and their significance.
  • How AsyncAPI facilitates designing event-driven systems.
  • Designing APIs for microservices using AsyncAPI for effective integration.

Module 3: AsyncAPI Specification

Scene: Eve assists Chan in programming his spaceship, ensuring they can communicate.

  • Understanding the AsyncAPI document structure and its core components.
  • Deep dive into AsyncAPI's components: info, channels, components, tags, etc.
  • Defining operations, messages, and schemas within AsyncAPI documents.

Module 4: Creating and Validating AsyncAPI Documents

Reaction: With the spaceship fixed, Eve looks forward to testing communication with Chan.

  • Writing and documenting AsyncAPI code from scratch.
  • Utilizing AsyncAPI tools for document validation.
  • Hands-on exercises for creating and validating AsyncAPI documents.

Module 5: Summary & Next Steps

End Scene: Reflecting on the journey as Chan returns to his planet.

  • Recap of what was learned across the modules.
  • Recommend exploring AsyncAPI tools.
  • Additional resources for extended learning, including documentation links and the AsyncAPI YouTube channel.

cc @smoya

Copy link
Member

@alequetzalli alequetzalli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mhmohona While this mentions creating an AsyncAPI document and document validation, we're still missing code creation with AsyncAPI.

Copy link
Member

@alequetzalli alequetzalli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mhmohona Thank you for adding code generation to your PR. 😄

Before we give this another technical review round, please notice how we have 2 sections repeating info about testing your work with the Studio tool. Please keep only one and remove the duplicate section.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants