Vote to determine topics to be covered in 100-level AsyncAPI Interactive Learning Path

[TRohit20]

As part of the GSoD’23 Program, To make learning and working with AsyncAPI more accessible, easy and fun, we are creating a 100-level Interactive Learning Path, which will be hosted on Killercoda Platform.

The idea behind the Interactive Learning Path is to introduce and teach users various topics of AsyncAPI through interactive story-telling so it eases implementation and adoption.

You can be anyone, a developer, architect, technical writer or anyone on a team or project working with AsyncAPI to build something. Your input matters and goes a long way as it helps us determine what are some topics that should be covered in the lessons such that the community on a whole benefits.

We would love to hear your thoughts and suggestions on “What are some topics that should be covered in the 100-level learning-path”.

Thank you!

[Devansh-Bhatt]

Hi @TRohit20 , this was something i was looking forward to for AsyncAPI. As a novice contributor to AsyncAPI and being a student, the use case of AsyncAPI is hard to understand given its domain and effort to make EDA maintainable and more accessible for the developers.

It's definitely not easy and quick to understand EDA and where does AsyncAPI fit in there to make it more serviceable. I know this would not be an issue for someone already having experience with EDA design and someone who has already worked with it. But for someone like a new contributor as myself would get highly benefitted if a resource/ learning path was provided to understand as well as implement EDA with the help of platform like Killercoda. This would make the need for the use of AsynAPI more robust and clear.

This is a just a suggestion from a novice Contributer.🙂

[quetzalliwrites]

It sounds like you're suggesting our first learning path takes the time to explain how/where AsyncAPI fits into EDA world...as well as explaining what is EDA.

Def agree with you there, we certainly aim to cover those items :)

[lornajane]

I really like this idea, but I'd like to extend it: could we also publish some of the materials in the docs or make those resources available somewhere else? The Killercoda platform doesn't meet basic accessibility standards, and I assume it's also quite difficult for search engines to index the materials there, so in order to reach more people it would be good to cross-publish materials to more traditional formats. This also helps us to maintain ownership of our content, in the event that something happens to the third-party platform.

[quetzalliwrites]

We cannot host interactive learning content in the static docs, they contradict purposes :)

We voted to use the Killercoda platform in the last few months, so now it is a little late to try and propose a different platform. (Your note about Killercoda being less accessible would have been more useful when we voted on platforms to implement interactive learning paths. 😂) That said, Killercoda is only one of the interactive platforms we plan to use, so we will definitely be able to re-purpose our killercoda content.

BTW, if you can, it would be more helpful if you answered the actual question proposed in this vote. Changing the topic to propose a different platform doesn't address the actual questions posed in this discussion by Rohit ✌🏽

[lornajane]

I think perhaps my original comment was not clear, and the response seems to assume some poor intent on my part. Let me try to give my comments more simply:

1. This sounds like a very exciting idea, I fully support it, on any platform.

2. Some of the materials we create for the interactive course could also be re-used in documentation, where more people could benefit. An example could be a written explanation of a concept, or an example that you think is particularly good.

I don't feel that my suggestion was well received, and I'd like to apologise if making a suggestion in this context was unwelcome or inappropriate.

[mhmohona]

Here are some suggested topics and subtopics:

1. Introduction to AsyncAPI

   • What is AsyncAPI?
   • Why use AsyncAPI?
   • Real-world use cases of AsyncAPI.

   Quiz: Multiple choice questions about the basics of AsyncAPI.
   Practical Exercise: Research and present a real-world use case of AsyncAPI.
   Summary: Debate on when to use AsyncAPI versus other API specifications.

2. AsyncAPI Specification

   • Understanding the structure of an AsyncAPI document.
   • Deep dive into various components of AsyncAPI: info, channels, components, tags, etc.
   • How to define operations (like send and address), messages, and schemas.

   Quiz: Fill in the blanks or match the terms with their definitions for components of an AsyncAPI document.
   Practical Exercise: Analyze an existing AsyncAPI specification document and identify its components.
   Summary: Discuss the importance of different components in an AsyncAPI document.

3. Creating and Validating AsyncAPI Messages and Documents

   • How to write an AsyncAPI messages and document from scratch.
   • Using AsyncAPI tools for validating the document.
   • Hands-on exercises to create and validate AsyncAPI documents.

   Quiz: True/False questions about creating and validating AsyncAPI documents.
   Practical Exercise: Write a simple AsyncAPI document and validate it using AsyncAPI tools.
   Summary: Share experiences and challenges faced while creating and validating AsyncAPI documents.

4. AsyncAPI and Event-Driven Architectures

   • Introduction to event-driven architectures.
   • How AsyncAPI can be used to design event-driven systems.
   • Designing APIs for microservices with AsyncAPI.

   Quiz: Multiple choice questions about event-driven architectures and their relation with AsyncAPI.
   Practical Exercise: Design a basic event-driven architecture for a given scenario and describe how AsyncAPI can be used in it.
   Summary: Discuss the role of AsyncAPI in designing event-driven systems and microservices.

5. AsyncAPI Tools and Libraries

   • Overview of tools and libraries available for AsyncAPI.
   • How to use AsyncAPI generator to create code, documentation, and more.
   • How to use the AsyncAPI React component to render documentation in your app.

   Quiz: Questions about various AsyncAPI tools and libraries.
   Practical Exercise: Use AsyncAPI generator to create code or documentation. Use the AsyncAPI React component to render documentation in an app.
   Summary: Discuss experiences with various AsyncAPI tools and libraries, their pros and cons.

6. Case Study and Hands-On Project

   • Analyzing a real-world application of AsyncAPI.
   • Creating a small project using AsyncAPI.

   Quiz: Questions based on the case study.
   Summary: Discuss the challenges and learning from the project, peer review each other's projects.

Project:

Towards the end of the course, learners can apply what they've learned in a hands-on project, such as designing an event-driven API for a simple application. This project can be presented and peer-reviewed, fostering collaborative learning.

[quetzalliwrites]

Thank you for the amazing proactivity and ideas, @mhmohona! We will majorly benefit from this comment, really appreciate you giving us a great content outline to get us started. ✨

[kakabisht]

I agree with many topics @mhmohona recommends, and I would like to add a suggestion. I would like a place where we could discuss our questions, seek guidance, or give feedback about the course. Similar to Discussions in Udacity or Leetcode.

[TRohit20]

Greetings folks, I hope you all are doing well. After carefully considering all the suggestions and inputs, we have determined the topics that will be covered in the 100-level interactive learning path for AsyncAPI. Please note that while all the inputs are valid and much appreciated, we chose topics solely based on the objective of keeping the learning path 100-level and not overwhelm the learners.

Here are the modules and topics we will be covering in the interactive learning path:

1. What is AsyncAPI?
   • What is AsyncAPI?
   • Why AsyncAPI?
   • Real world use cases and example
2. What are Event Driven Architecture/Systems?
   • Talk about EDAs
   • Background, use cases
   • How it relates to AsyncAPI
3. AsyncAPI Specification
   • Intro to AsyncAPI specification and document
   • Understanding the structure of an AsyncAPI document.
   • Dive into various components of AsyncAPI such as info, channels, components, tags, etc.
   • Request/reply intro
4. Creating and validating a AsyncAPI document
   • How to write an AsyncAPI messages and document from scratch.
   • Using AsyncAPI tools for validating the document.
   • Hands-on exercises to create and validate AsyncAPI documents.
5. Summary with pointers to tools.
   • Summarising the learning
   • Pointers to what next such as tooling or frameworks