community
community copied to clipboard
asyncapi
Create educational & technical video explaining AsyncAPI's main features
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?...)
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.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
@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?
@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 😄
@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)
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?
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!!
Great @alequetzalli! Of course, we have to give more visibility to women in the sector 💜
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
Yes, we could make the videos of 5-15 minutes, being flexible here, and then take out a teaser for social networks.
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.
@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
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 :)
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 ❤️
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
- What are APIs
- What kind of API architectures exist
- What is AsyncAPI
- AsyncAPI and OpenAPI
- Open Governance and transparency
- 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: https://github.com/asyncapi/training/pull/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: https://github.com/asyncapi/training/pull/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: https://github.com/asyncapi/training/pull/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: https://github.com/asyncapi/training/pull/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: https://github.com/asyncapi/training/pull/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: https://github.com/asyncapi/training/pull/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 :)
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?
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
Thank you for your feedback @derberg
Video 4: Open GovernanceWe 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?
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?
I think that script should say exactly what the person should say. Is this what you ask?
Yes, this was my doubt, thank you 🙂
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?
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.
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
Hi! While creating and revising scripts, we can look for graphic connections between the text we are working on from the videos and what will appear on the screen. This work will allow us to design the sketch of each video. An option would be to represent it in a storyboard.
I've been looking at different storyboarding tools. I think I'm going to start with Storyboarder since it's a program open-source, simple, accessible, and works with formats easily exportable to video editing programs.
The initial idea of the patterns of the videos could be the following:
- Intro
- Presentation, the speaker in full screen
- Video content in full screen and a thumbnail image of the speaker
- Farewell, the speaker in full screen
- Outro
What do you think?
@Barbanio Good idea on the Storyboarding! I think that your outline is good but I am thinking that we could bring the speaker in full screen at some points during the video content portion. This will help to retain attention and could break up the monotony by retaining that connection between the viewer and the speaker. What do you think?
@mcturco Sure, it's a good idea. This is just a general approach. When the speakers might be putting stress on some words, we can include their images. Trying to find a more dynamic rhythm for the videos.
Hello! Finally, when I started working with Storyboarder, I realized that it wasn't practical to give direct feedback on the storyboard. So, I decided to look for different options, and, in the end, I chose to do it in PowerPoint because it is accessible to everyone, and you can give feedback directly on a specific point of the project. We can leave comments in the place of the storyboard that we consider appropriate.
So here is the link to the storyboard for the first video: https://docs.google.com/presentation/d/17PNiF0sccegW92sXvrBPfx77YyWtKfZt/edit#slide=id.p2
Creating a slideshow describing the speaker seemed a bit dull, and I thought it might be done more dynamically. For doing so, it is necessary to have a designer to take care of the graphic part.
@mcturco, I've put a fragment of one of the last videos you've created for the brand to simulate the effect of intro and outro. Could we count on your talent for this?
This is looking good! I can help out with the visual style as well to make sure it matches the brand guidelines (the guidelines are in progress as well). And yes, I can help with the intro if you guys just want to let me know what text should be there. Like maybe "Learning AsyncAPI" or something generic like that so we can easily stick it in front of all future videos as well.
I was looking through the presentation and it seems like the script is a bit different in the presentation than it is in the PR in training, I didn't read through the whole thing just yet, but for example:
On slide 6 it says Last but not least, we will check the benefits they bring to us.
And then on slide 7 it says Finally, we will see a demo of an API.
However I think that the grammar doesn't make sense here. Last but not least is meant to represent the very last item and doesn't make too much sense for the second to last item. When cross-referencing this with the PR for the first video script, it looks like there was some improv added to the storyboard, but I could be wrong! I think instead it could be like this:
- First of all, we will start by talking about what APIs are.
- Secondly, I will show you a brief history of APIs.
- ~Later~ Next, I will go on talking about the different types of APIs that exist.
- ~Last but not least~ Later, we will check the benefits they bring to us.
- Finally, we will see a demo of an API.
Other than that, I just have a question about how these will be put together. Are we counting on it being a presentation style where the speaker will show all the slides on the screen, or are we going to rely on heavy video editing and motion graphics to produce these? Just mentioning it because I don't think I have time to help with the video editing side (aside from the intro, in which I don't mind preparing). But I know Kin was looking to add a video editor to the team so maybe they can work on this? Not sure, but I thought I would just put that out there so everyone can be on the same page!
Great work so far! @Barbanio @alequetzalli
@mcturco, thanks for the great feedback!
And yes, I can help with the intro if you guys just want to let me know what text should be there. Like maybe "Learning AsyncAPI" or something generic like that so we can easily stick it in front of all future videos as well.
I think either option would be fine. Let's see what others think.
I was looking through the presentation and it seems like the script is a bit different in the presentation than it is in the PR in training, I didn't read through the whole thing just yet, but for example:
The only modifications to the main script are those. I thought it was more natural if we included that brief description of what will be talked about in the video. I have included your review in the storyboard and in the main script.
Other than that, I just have a question about how these will be put together. Are we counting on it being a presentation style where the speaker will show all the slides on the screen, or are we going to rely on heavy video editing and motion graphics to produce these?
I think this will depend on the possibilities we have. I have been watching different educational videos, and these are the ideas that I like the most. I especially like how they do it at IBM, but the other option (with the speaker on the screen) is more feasible for us. Anyway, I think the best is something simple and nice :)
https://www.youtube.com/watch?v=kG-fLp9BTRo https://www.youtube.com/watch?v=s7wmiS2mSXY
What do you think?
But I know Kin was looking to add a video editor to the team so maybe they can work on this? Not sure, but I thought I would just put that out there so everyone can be on the same page!
I have asked Kin if we have any news about the video editor to know the real technical possibilities we have.