Create educational & technical video explaining AsyncAPI's main features

[quetzalliwrites]

Reason/Context

Creating an educational & technical video explaining AsyncAPI's main features will be helpful for new on-boarders that need a high-level intro to the spec.

This video can be used for any kind of audience and should be agnostic-minded.

---

Tagging @derberg @Barbanio @fmvilas

(note: Can lukasz or someone help me tag Debi into this issue? I don't know her GH handle and me trying @Docjones doesn't seem to be working here, that seems to belong to someone named Mark?...)

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[Barbanio]

@alequetzalli That's a great idea, of course, count me in. I understand that the main objective is a promotional and educational video that summarizes what AsyncAPI is, can it be?
On the other hand, I wonder if it is better to make a single video or a series of these. What do you think?

[Docjones]

Guess that's not related to me in any way...?

[derberg]

@alequetzalli GH sucks in proper support to research on user handle when tagging -> @doc-jones (this is our Doc 😄 )

@Docjones not, but you can join us here, especially if you did not hear about AsyncAPI and much about Event-Driven Architecture before, we would love to see some validate the script and idea for the video 😄

[boyney123]

@alequetzalli I love the idea, would of helped me loads when I was learning what's going on and the ins + outs of AsyncAPI.

On the other hand, I wonder if it is better to make a single video or a series of these. What do you think?

@Barbanio think my vote would be series of smaller videos, each video that focuses on a particular part of the spec, just some examples

• What is AsyncAPI
• Why it was created
• Defining Events with AsyncAPI
• Publish/Subscribe
• etc...

To be honest once you get passed that stuff, would be cool to go into features like, Modelina, Studio, CLI etc.... (maybe)

[Barbanio]

Hi! I would like to start working on this. I agree with a series of short videos would be best.

My proposal is as follows:

• Videos of 10-15 minutes in length.
• Starting with general topics and gradually covering more specific topics as @boyney123 points out.
• The videos would be free and open access.
• Could we have a section on the AsyncAPI website for this in "Learning"?

What do you think? Who would be interested in participating?

[quetzalliwrites]

I am interested in participating, but mostly because I want women on those videos too. 😀 (@Barbanio, would you also do some of them so that we have several women faces too? ❤️✨✨)

I love the idea of creating a playlist for this learning vids and of thinking more about what creating a simple Learning platform for us could look like. 😀 I have started thinking about this more and more lately!!

[Barbanio]

Great @alequetzalli! Of course, we have to give more visibility to women in the sector 💜

[derberg]

I suggest rethinking the length of videos or basically being flexible there. When you will work on scripts, consider 1min length of videos to later release these as YouTube Shorts. Shorter videos, more chance people will watch it

[Barbanio]

Yes, we could make the videos of 5-15 minutes, being flexible here, and then take out a teaser for social networks.

[doc-jones]

Since this is basically an experiment, we should do all the things with a plan to measure the results so that we can do more of what works and less of what doesn't. Does our audience want 1 min teaser videos or should we do longer videos? What about adding links in the Show More tab? As an avid consumer of Youtube videos, I always appreciate those links pointing me to where I can get more information or detail.

I would think the length of videos is a result of the topic or content covered. So maybe we start with a list of topics like @boyney123 presented and see how long it takes to cover that topic? I'm a fan of experimentation when doing a new thing, because it gives our audience the chance to choose and we learn more from it. The key will be a plan to measure our results.

[doc-jones]

@alequetzalli GH sucks in proper support to research on user handle when tagging -> @doc-jones (this is our Doc 😄 )

"@"Docjones not, but you can join us here, especially if you did not hear about AsyncAPI and much about Event-Driven Architecture before, we would love to see some validate the script and idea for the video 😄

For future reference, the link to my github presence is given on my LinkedIn profile. Alternatively, you could just ask me. heh

[boyney123]

Since this is basically an experiment, we should do all the things with a plan to measure the results so that we can do more of what works and less of what doesn't

Yeah I agree with @doc-jones here, we should do some things and learn from feedback etc (whatever that looks like)

Does our audience want 1 min teaser videos or should we do longer videos?

Same with @doc-jones I'm a huge user of Youtube to learn stuff, 1 minute videos personally would not be enough for me, when I learn a new tool or thing I personally want more than a minute, something high level, with slight level of detail, but having more detailed videos if I wanted them (maybe we do them in the future).

I'm also interested in helping out and making some videos count me in :)

[derberg]

We should just be flexible and try to satisfy as many different users as possible. There will always be different preferences and thing that @Barbanio wrote I think makes most sense

Yes, we could make the videos of 5-15 minutes, being flexible here, and then take out a teaser for social networks.

Why? because we already have one experiment done: https://www.youtube.com/watch?v=pU71J-F7pfI

I recorded ☝🏼 this last year, for the Hacktoberfest participants, there was a series of videos that I wanted to give folks to onboard them quickly to contributions. As you can see, quality is not what attracts people there (I did not have good equipment at that time, paid by Open Collective, not Postman 😆 ) and I'm also not 100% happy with the content. What I do know is that people open it up for 2 reasons:

• title
• they see it is super short

does it mean we should have only short videos? NO 😄
it is just that when you will work on scripts for videos, I bet there will always be a chance to figure a "short version" and "advanced version". Like basically "watch short? want more details explanation, watch longer one"

Anyway, love the initiative ❤️

[Barbanio]

Organization and Script of the workshops:

To organize the structure, I think that perhaps we could do it in blocks to organize the common thread of the videos.

I think that starting with a general and global overview of the AsyncAPI environment will help the user who does not know some of these terms to better understand the specification.

Example:

Block 1: Introduction to the world of AsyncAPI

1. What are APIs
2. What kind of API architectures exist
3. What is AsyncAPI
4. AsyncAPI and OpenAPI
5. Open Governance and transparency
6. Working in a community

Video 1: What are APIs

• What are APIs
• Brief history of APIs (when and how APIs were born)
• Types of APIs
• Benefits of APIs

🔗 Script: asyncapi/training#8
🔗 Storyboard: https://docs.google.com/presentation/d/1WAlxxo-neqac5hczq8sCTMYx9jqelwvZ/edit#slide=id.p1

Video 2: What kind of API architectures exist

• Synchronous and asynchronous APIs
• API Architecture definition
• Types of APIs architecture
  • Monolithic
  • Microservices
  • Serverless
  • Event-driven
• AsyncAPI and EDA

🔗 Script: asyncapi/training#9
🔗 Storyboard: https://docs.google.com/presentation/d/1mdkh2LxOAzcB_V8Kbtq0L_qyCG1tbG-u/edit#slide=id.p1

Video 3: What is AsyncAPI

• What is AsyncAPI Spec, and how did it come about
• What AsyncAPI brings
• What is AsyncAPI Initiative, and what are its objectives
• AsyncAPI on the long-term

🔗 Script: asyncapi/training#10
🔗 Storyboard: https://docs.google.com/presentation/d/1iQpyAtfeU7ouqyW0euyAMMMOVltcfUQ4/edit#slide=id.p1

Video 4: AsyncAPI and OpenAPI

• What is OpenAPI
• Similarities between AsyncAPI and OpenAPI
• Differences between them
• AsyncAPI and OpenAPI comparison

🔗 Script: asyncapi/training#11
🔗 Storyboard: https://docs.google.com/presentation/d/19C8OZ2yM5xSjPBT8eJABIVUlzy9RAcPD/edit#slide=id.p1

Video 5: Open governance and transparency

• AsyncAPI and Linux Foundation
• Why transparency
• Why open governance
• AsyncAPI governance model
• Putting theory into practice

🔗 Script: asyncapi/training#12
🔗 Storyboard: https://docs.google.com/presentation/d/1KSuUHk0l_Wy8_RmE-2CUFi1yBeAuSFwU/edit#slide=id.p1

Video 6: Working in community

• Collective strength
• Working as a community
• AsyncAPI Initiative and its community
• How to join the AsyncAPI community

🔗 Script: asyncapi/training#14
🔗 Storyboard: https://docs.google.com/presentation/d/1Ju-EZtGHFG5GxFbSd9pZeZptuK1Xk6f6/edit#slide=id.p1

Block 2: How to start using AsyncAPI
(...)

This content and structure are just an idea. Your feedback is welcome :)

[Barbanio]

Hi, I would love to start working with the videos for the Block 1. For this we would need:

• An intro and an outro to put at the beginning and end of each recording, could you give us a hand with this, @mcturco?

• Speakers. It would be a 5 to 15 minutes recording developing the script points (the script is modifiable and adaptable). For this it would be interesting to consider diversity in the speakers. Perhaps we could provide some kind of incentive to the participants.

• Besides the diffusion in the conventional channels, can you think how we can attract people interested in be speaker? What do you think? @alequetzalli you have experience in groups with minority presence in the field of technology, any suggestions?

[derberg]

Video 3: What is AsyncAPI

We also need a separate video on the differences between AsyncAPI and OpenAPI. This is the most performing article we had last year. Many folks come here from OpenAPI, and we also openly say that AsyncAPI is inspired by (actually a lot of spec was copied from them) OpenAPI

Video 4: Open Governance

We should have a video also that explains how this model works here, TSC and stuff

Speakers. It would be a 5 to 15 minutes recording developing the script points (the script is modifiable and adaptable). For this it would be interesting to consider diversity in the speakers. Perhaps we could provide some kind of incentive to the participants.

Once we have scripts, finding speakers will be super easy. I can help. We have a solid amount of women in the community that we can ask for help, to make sure we have diverse representation. More challenging will be the recording process, basically how we do it, instructions, and most importantly - how we make sure we get high quality. I have no idea 😄

It would be a 5 to 15 minutes recording

Let us just remember that whenever we work on long scripts, short script should also be prepared. We need long and short videos. If we will not combine these efforts now, we won't do it long term at all.

It is not just my opinion -> https://asyncapi.slack.com/archives/C34F2JV0U/p1641478994014400

[Barbanio]

Thank you for your feedback @derberg

Video 4: Open Governance

We should have a video also that explains how this model works here, TSC and stuff

Do you think this topic could be addressed at one point in this video or would it be better to make a separate video?

More challenging will be the recording process, basically how we do it, instructions, and most importantly - how we make sure we get high quality. I have no idea 😄

Yes, I'm working on this 🙂

Let us just remember that whenever we work on long scripts, short script should also be prepared. We need long and short videos. If we will not combine these efforts now, we won't do it long term at all.

I agree with you but I have a doubt about the scripts, do you mean to transcribe literally the content of the video or to do it more schematically?

[derberg]

Do you think this topic could be addressed at one point in this video or would it be better to make a separate video?

Actually, I somehow thought each bullet point is a separate video 😄 I think now have idea for how to have long and short videos 😄

I agree with you but I have a doubt about the scripts, do you mean to transcribe literally the content of the video or to do it more schematically?

not sure what you mean by schematically. I think that script should say exactly what the person should say. Is this what you ask?

[Barbanio]

I think that script should say exactly what the person should say. Is this what you ask?

Yes, this was my doubt, thank you 🙂

[quetzalliwrites]

Hi, I would love to start working with the videos for the Block 1. For this we would need:

• An intro and an outro to put at the beginning and end of each recording, could you give us a hand with this, @mcturco?
• Speakers. It would be a 5 to 15 minutes recording developing the script points (the script is modifiable and adaptable). For this it would be interesting to consider diversity in the speakers. Perhaps we could provide some kind of incentive to the participants.
• Besides the diffusion in the conventional channels, can you think how we can attract people interested in be speaker? What do you think? @alequetzalli you have experience in groups with minority presence in the field of technology, any suggestions?

Hey @Barbanio, finally caught up with this thread 😄✨✨.. I honestly am in awe of the outline you proposed/created. I literally love it and can't think of any suggestions or feedback! You are so good at this! 🙊🥳🥳🥳

To your questions, I think we need to begin by simply doing it ourselves. I mean, now we have more women like you, @mcturco , myself... so I would honestly first like to propose that ANYONE can band together to write scripts, but I vote for us three women volunteering to be the video speaker for at least 1 video each. I really think we can start adding diversity by doing it first ourselves and thus start attracting more women. IF they see OUR faces --as women-- they will have a bigger incentive to join and want to do contributions (like this one). ❤️ What do you think?

[Barbanio]

so I would honestly first like to propose that ANYONE can band together to write scripts

Yes, of course, the more people involved the better the result!

(...)but I vote for us three women volunteering to be the video speaker for at least 1 video each. I really think we can start adding diversity by doing it first ourselves and thus start attracting more women. IF they see OUR faces --as women-- they will have a bigger incentive to join and want to do contributions (like this one). ❤️ What do you think?

I agree with you, it makes complete sense.

[mcturco]

I would definitely be open to being a speaker if that helps!

[doc-jones]

I found this video while doing some research on GraphQL. What I love about this is the demo is something individually useful and illustrates a bigger concept. How much are your bagels costing you? heh. I just thought I'd share this as the team is in the planning phase for doing all sorts of videos.

https://portal.gitnation.org/contents/the-secret-to-graph-onboarding

[Barbanio]

Hello @Sihamtahi, nice that you feel like working on this, Welcome! 😀 As @alequetzalli says, we need more people to contribute to this to make the videos as good as possible.

As you can see these are the videos we are working on now, I think some new eyes on them would be great. If you feel like writing from scratch of course you can do that too, you can start with a proposal from block 2 of the videos and work on that too.

Personally, I think we should prioritize the videos from the first block to move forward on them. What do you think?

[Sihamtahi]

Hello @Barbanio and @alequetzalli, thank you for adding me, I will be glad to contribute with you. It's a great Idea I think to get everything done with the block 1.
For now, I will try to read every script that you already wrote and I will tell if I have further remarks / propositions.

[mcturco]

Hi!
I have put together a Google Slides theme/template with the new branding:
https://docs.google.com/presentation/d/1ymmSVff8G-n9ktkmTyUvbTmtY-q6fAZ-qqX57CVCb6w/edit?usp=sharing

Let me know if there is a layout that you need that is not currently there, but keep in mind if its specific to a single educational video and won't be re-used, I would create that as a custom slide from the "Blank" layout included.

If you have any questions/concerns, let me know! But wanted to get this to you sooner rather than later.

[Barbanio]

@mcturco Looks great! Thanks for your swift reaction ✨

[Barbanio]

@mcturco, I can't edit the text on the second slide. The rest works great!

[Barbanio]

Hi! This is the second version of the storyboard of the first video: https://docs.google.com/presentation/d/1WAlxxo-neqac5hczq8sCTMYx9jqelwvZ/edit#slide=id.p1 What do you think? 🙂

[Barbanio]

Hello!

Work continues on the first block of videos. These are the latest news:

• Animations have been included in the scripts.
• The voice-over that will accompany the animations has been added.
• The script for the short version of each video has been marked up.
• Storyboards have been updated with the changes in the scripts.

You can check this here:

Video 1: What are APIs - 🔗 Script: asyncapi/training#8 🔗 Storyboard: https://docs.google.com/presentation/d/1WAlxxo-neqac5hczq8sCTMYx9jqelwvZ/edit#slide=id.p1

Video 2: What kinds of API architectures exist - 🔗 Script: asyncapi/training#9 🔗 Storyboard: https://docs.google.com/presentation/d/1mdkh2LxOAzcB_V8Kbtq0L_qyCG1tbG-u/edit#slide=id.p1

Video 3: What is AsyncAPI - 🔗 Script: asyncapi/training#10 🔗 Storyboard: https://docs.google.com/presentation/d/1iQpyAtfeU7ouqyW0euyAMMMOVltcfUQ4/edit#slide=id.p1

Video 4: AsyncAPI and OpenAPI - 🔗 Script: asyncapi/training#11 🔗 Storyboard: https://docs.google.com/presentation/d/19C8OZ2yM5xSjPBT8eJABIVUlzy9RAcPD/edit#slide=id.p1

Video 5: Open Governance and transparency - 🔗 Script: asyncapi/training#12 🔗 Storyboard: https://docs.google.com/presentation/d/1KSuUHk0l_Wy8_RmE-2CUFi1yBeAuSFwU/edit#slide=id.p1

Video 6: Working in community - 🔗 Script: asyncapi/training#14 🔗 Storyboard: https://docs.google.com/presentation/d/1Ju-EZtGHFG5GxFbSd9pZeZptuK1Xk6f6/edit#slide=id.p1

It would be great to have some revisions 🙂

@thulieblack @Florence-Njeri @asyncapi/ambassadors

[thulieblack]

Hey @Barbanio should we do revisions on the scripts right?

[Barbanio]

Hi @thulieblack , If you feel like it, it would be great to receive your comments 🙂

[derberg]

I wasn't sure where to put my update, if separate discussion or here. So yeah, putting here and let's see.

tl;dr
I had a call with Linux Foundation on below because I was approached by one company offering support in creating training/learning materials:

• regarding trainings authoring with LF support
• licensing of such content

What I learned:

• LF has its "own" platform where they publish trainings, but in reality, they also republish to https://www.edx.org/school/linuxfoundationx for a larger audience
• If we put AsyncAPI training there, LF can even give us some budget to sponsor its creation 💪🏼
• Content is owned by LF and is licensed under Creative Commons license, so we are still allowed to reuse it, like in the future in the AsyncAPI website, if we want and have some e-learning (platform for interactive learning, like killercoda license) in place 💪🏼
• LF is kinda expert in the field as they already have a large set of trainings, free and paid + certifications
• LF gives us visibility and advertisement of trainings in LF community
• Suggestion is that we first focus on one free training, like Introduction to AsyncAPI to see how popular it is, and if people are actually interested. Which makes sense 💪🏼
• We open up to the option that, in the future, we can also have paid training that we could use to sponsor the project
• Future future of our close cooperation with LF -> paid certification ❤️
• You can check out how this platform works by enrolling in one of trainings like https://www.edx.org/course/introduction-to-istio

So far, what I learned is super, in my opinion, and I'm super interested in what you think. Am I too optimistic?

cc @Barbanio @thulieblack @AceTheCreator @alequetzalli

[thulieblack]

This is really cool, not only will it give exposure to the community (branding) but also serves as onboarding material. Count me in😁

[Barbanio]

Yes, I agree with you both. It's a fantastic opportunity. I only see good points. Count me in too! 🙂

[quetzalliwrites]

Sounds very promising! Here or killercoda seem viable options to me.

One comment: paid certifications do not have my vote, not for OSS :)

[github-actions]

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

[AnimeshKumar923]

is this issue still valid? 👀
cc: @derberg @fmvilas @mcturco @alequetzalli @thulieblack @Barbanio

[Barbanio]

Hi @AnimeshKumar923, yes! We would like to activate it again very soon.

[AnimeshKumar923]

Hi @AnimeshKumar923, yes! We would like to activate it again very soon.

Okay then!

[github-actions]

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]

@alequetzalli do you continue with recording scripts that were created under training repo?

[github-actions]

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

[thulieblack]

Reviving this for 2025 goals cc @thulieblack