-
-
Notifications
You must be signed in to change notification settings - Fork 140
docs: webinar series initiative #1847
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Rest looks good to me.
please follow the appropriate Conventional Commits |
Co-authored-by: Rohit <[email protected]>
Co-authored-by: Rohit <[email protected]>
WalkthroughA new document has been added describing the AsyncAPI Webinar Series Initiative. The document outlines the purpose, goals, benefits, format, event checklist, potential speakers, and calls to action for the webinar series, providing comprehensive guidelines for organizing and participating in the initiative. Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (5)
webinar_series_initiative.md (5)
7-10
: Enhance Descriptor for InsightsOn lines 9–10, the phrase “gain deeper insights” could be strengthened. Consider using “gain in-depth insights” to deliver a more impactful message.
-As AsyncAPI continues to evolve, we recognize the need for more interactive and accessible learning opportunities. While documentation, blog posts, and conferences are great, webinars offer a real-time, engaging format where participants can ask questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. +As AsyncAPI continues to evolve, we recognize the need for more interactive and accessible learning opportunities. While documentation, blog posts, and conferences are great, webinars offer a real-time, engaging format where participants can ask questions, share experiences, and gain in-depth insights into the AsyncAPI ecosystem.🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider an alternative adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
32-37
: Refine Bullet Point PhrasingThe bullet points in the “Benefits of the Webinar Series” section all begin with “For …”. Rephrasing these can improve the flow and readability. For example:
- - For Attendees: Learning, skill-building, and networking opportunities. - - For Speakers: Exposure, recognition, and a platform to share ideas. - - For the Community: A growing knowledge base, increased collaboration, and a more vibrant ecosystem. + - Attendees enjoy learning, skill-building, and networking opportunities. + - Speakers benefit from enhanced exposure, recognition, and a platform to showcase their ideas. + - The community gains an expanding knowledge base, improved collaboration, and a more vibrant ecosystem.🧰 Tools
🪛 LanguageTool
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
40-40
: Heading Formatting – Remove Trailing PunctuationThe heading “### For Hosts:” on line 40 ends with a colon, which is flagged by markdown lint. Removing it will ensure consistency with style guidelines.
-### For Hosts: +### For Hosts🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
40-40: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
42-42
: Typo CorrectionIn the bullet under “For Hosts”, “familarized” is misspelled. It should be “familiarized”.
- - Get familarized with the hosting platform (Restream) + - Get familiarized with the hosting platform (Restream)
48-48
: Heading Formatting – Remove Trailing PunctuationSimilarly, the heading “### For Guests:” on line 48 ends with a colon. Removing the colon will align the heading with markdown style guidelines.
-### For Guests: +### For Guests🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
48-48: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
webinar_series_initiative.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
webinar_series_initiative.md
[style] ~9-~9: Consider an alternative adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
webinar_series_initiative.md
40-40: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
48-48: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (11)
webinar_series_initiative.md (11)
1-2
: Great Title and OverviewThe title clearly sets the tone and purpose of the document. The use of a descriptive headline benefits readers immediately.
3-6
: Clear Introduction SectionThe introduction succinctly communicates the initiative’s purpose and audience. The message is clear and engaging.
11-15
: Well-Defined GoalsThe “Our goals include:” section is concise and clearly outlines the objectives of the webinar series.
16-23
: Why You Should Attend is EffectiveThis section clearly communicates the benefits for attendees. The bullet points are direct and informative.
24-31
: Compelling Call to SpeakThe “Why You Should Speak” section effectively encourages potential speakers by highlighting tangible benefits.
55-61
: Solid Content Structure OutlineThe “Suggested Content Structure” section clearly lays out the webinar flow. The steps are well-organized and easy to follow.
62-78
: Comprehensive Event ChecklistBoth the “Pre-Event” and “Post-Event” checklists are thorough and cover necessary logistics for a successful webinar.
79-87
: Effective Potential Speakers SectionThe section on potential speakers communicates diversity in expertise and inclusivity effectively.
88-93
: Strong Recap SectionThe recap of the first session is engaging, and the inclusion of a replay link adds great value for those who missed the live event.
94-100
: Engaging ConclusionThe “What’s Next?” section does a great job of inviting ongoing participation and clearly calls the community to action.
1-100
: Commit Message Best Practices ReminderWhile the document is well-structured and comprehensive, please ensure that future commit messages adhere to the Conventional Commits guidelines as recommended in previous discussions.
🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider an alternative adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
40-40: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
48-48: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor additions, but make sure that everyone who usually hosts the series reviews and approves the requirements. Also, it'll be nice to know which community/marketing goal the initiative aligns with and how frequently the series will be for consistency's sake.
webinar_series_initiative.md
Outdated
|
||
The AsyncAPI Webinar Series is just getting started! Stay tuned for upcoming sessions, and if you have suggestions for topics or speakers, we’d love to hear from you. | ||
|
||
Want to attend the next session? Follow our updates and turn on notifications! 📢 Interested in speaking? Reach out to us—we’d love to have you! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where should they follow for updates? To whom are they reaching out, and how do they propose a topic?
webinar_series_initiative.md
Outdated
|
||
### Post-Event | ||
|
||
- Share a recap blog post and recording. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Who will write the blog post? Recording I may understand
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Me! If it won’t be too much of a blog post. I plan to write a summary blog after each webinar. Do you advise otherwise? @thulieblack
webinar_series_initiative.md
Outdated
### Post-Event | ||
|
||
- Share a recap blog post and recording. | ||
- Gather feedback from attendees and speakers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How will the feedback be gathered?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The same way the previous one was gathered. From the attendees' comments on Youtube and on socials when it’s landed.
- Interactive Q&A: Participants get the chance to ask questions and engage with the speaker. | ||
- Closing Remarks: Final takeaways, announcements, and what’s coming next. | ||
|
||
## Event Checklist (Pre and Post) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make this section an actual checklist.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright @thulieblack
webinar_series_initiative.md
Outdated
- Keep the session on time and moderate the Q&A effectively. | ||
- Coordinate with the speaker in advance to understand their presentation flow. | ||
|
||
### For Guests: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any recommended aspect ratio to be used? Guidelines on how to present the demo would be good. And mention how the demos should be visible
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aspect ratio?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes aspect ratio for when they're presenting demos
Alright. |
@iambami any update here? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
webinar_series_initiative.md (1)
90-93
: 🛠️ Refactor suggestionEnhance call-to-action: add LinkedIn link and fix typos
- Provide the actual AsyncAPI LinkedIn URL.
- Correct "subcribe" → "subscribe".
- Wrap URLs in angle brackets to prevent Markdown parsing issues.
-The AsyncAPI Webinar Series is just getting started! Stay tuned for upcoming sessions, and if you have suggestions for topics or speakers, [we’d love to hear from you](https://join.slack.com/t/asyncapi/shared_invite/zt-32hejdicx-NrD~boRq71gpCBJAM8mFoA). +The AsyncAPI Webinar Series is just getting started! Stay tuned for upcoming sessions, and if you have suggestions for topics or speakers, [we’d love to hear from you](<https://join.slack.com/t/asyncapi/shared_invite/zt-32hejdicx-NrD~boRq71gpCBJAM8mFoA>). -Want to attend the next session? Follow our updates on LinkedIn, [subcribe to our YouTube page and turn on notifications!](https://www.youtube.com/@AsyncAPI) Interested in speaking? Reach out to us, we’d love to have you! +Want to attend the next session? Follow our updates on LinkedIn at <https://www.linkedin.com/company/asyncapi/>, subscribe to our YouTube page and turn on notifications: <https://www.youtube.com/@AsyncAPI>. Interested in speaking? Reach out to us, we’d love to have you!
♻️ Duplicate comments (1)
webinar_series_initiative.md (1)
5-6
: Introduction follows previously suggested copy
The introduction mirrors the wording recommended by @TRohit20 and effectively sets the tone for the initiative. Well done.
🧹 Nitpick comments (2)
webinar_series_initiative.md (2)
9-10
: Consider strengthening the adjective in the key sentence
The phrase "gain deeper insights" is clear, but you might consider a stronger adjective for impact (e.g., "gain profound insights").-While documentation, blog posts, and conferences are great, webinars offer a real-time, engaging format where participants can ask questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. +While documentation, blog posts, and conferences are great, webinars offer a real-time, engaging format where participants can ask questions, share experiences, and gain profound insights into the AsyncAPI ecosystem.🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
48-54
: Improve guest guidelines with aspect ratio recommendation
- Remove trailing colon in the guest heading.
- Suggest including a recommended aspect ratio for demos to address display consistency.
-### For Guests: +### For Guests - Prepare slides or a live demo that fits the topic. +- Prepare slides or a live demo that fits the topic. +- Ensure slides and demos are in a 16:9 aspect ratio for optimal viewing.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
48-48: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
webinar_series_initiative.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
webinar_series_initiative.md
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🪛 markdownlint-cli2 (0.17.2)
webinar_series_initiative.md
40-40: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
48-48: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
@AceTheCreator @TRohit20 your review |
Hey @AceTheCreator, @thulieblack, and @TRohit20, please give your final review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
♻️ Duplicate comments (1)
webinar_series_initiative.md (1)
1-1
: Title consistency verified.
The document title now matches the file name and PR objective, including “Series” for clarity.
🧹 Nitpick comments (3)
webinar_series_initiative.md (3)
9-9
: Consider stronger adjective to replace “deeper.”
To enhance impact, you might substitute “gain deeper insights” with a more vivid phrase, such as “gain comprehensive insights” or “gain in-depth insights.”🧰 Tools
🪛 LanguageTool
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...(DEEP_PROFOUND)
75-76
: Specify feedback collection method.
To close the feedback loop, clarify how feedback will be gathered (e.g., via a survey link, Slack poll, YouTube comments). For example:- [ ] Gather feedback from attendees and speakers via a post-event survey (e.g., Google Forms or Typeform) and Slack channel poll.
90-93
: Fix typo and add LinkedIn link.
- Correct “subcribe” → “subscribe.”
- Provide the LinkedIn updates link for consistency.
Example diff:-Want to attend the next session? Follow our updates on LinkedIn, [subcribe to our YouTube page and turn on notifications!](https://www.youtube.com/@AsyncAPI) +Want to attend the next session? Follow our updates on [LinkedIn](https://www.linkedin.com/company/asyncapi/) and [subscribe to our YouTube channel](https://www.youtube.com/@AsyncAPI) to turn on notifications!
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
webinar_series_initiative.md
(1 hunks)
🧰 Additional context used
🪛 LanguageTool
webinar_series_initiative.md
[style] ~9-~9: Consider a different adjective to strengthen your wording.
Context: ... questions, share experiences, and gain deeper insights into the AsyncAPI ecosystem. ...
(DEEP_PROFOUND)
[style] ~36-~36: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ition, and a platform to share ideas. - For the Community: A growing knowledge base...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (1)
webinar_series_initiative.md (1)
5-6
: Intro paragraph well-aligned with community vision.
The opening succinctly captures the AsyncAPI community’s collaborative spirit and clearly introduces the webinar series.
### For Hosts | ||
|
||
- Get familiarized with the hosting platform (Restream) | ||
- Prepare an engaging introduction and closing. | ||
- Research and prepare relevant questions tailored to the speaker's topic. | ||
- Keep the session on time and moderate the Q&A effectively. | ||
- Coordinate with the speaker in advance to understand their presentation flow. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Add aspect ratio and demo presentation guidelines.
Hosts would benefit from explicit technical guidance (e.g., recommended video aspect ratio like 16:9, minimum resolution, lighting/screen-capture tips) to ensure demos display clearly for all participants. Consider adding a bullet under “For Hosts”:
### For Hosts
- Get familiarized with the hosting platform (Restream)
+- Ensure video is in 16:9 aspect ratio (1080p recommended) and demos are clearly visible (proper lighting and screen capture tools).
- Prepare an engaging introduction and closing.
...
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
### For Hosts | |
- Get familiarized with the hosting platform (Restream) | |
- Prepare an engaging introduction and closing. | |
- Research and prepare relevant questions tailored to the speaker's topic. | |
- Keep the session on time and moderate the Q&A effectively. | |
- Coordinate with the speaker in advance to understand their presentation flow. | |
### For Hosts | |
- Get familiarized with the hosting platform (Restream) | |
- Ensure video is in 16:9 aspect ratio (1080p recommended) and demos are clearly visible (proper lighting and screen capture tools). | |
- Prepare an engaging introduction and closing. | |
- Research and prepare relevant questions tailored to the speaker's topic. | |
- Keep the session on time and moderate the Q&A effectively. | |
- Coordinate with the speaker in advance to understand their presentation flow. |
🤖 Prompt for AI Agents
In webinar_series_initiative.md around lines 40 to 47, add a bullet point under
the "For Hosts" section that provides technical guidance for demo presentations.
Include recommended video aspect ratio (such as 16:9), minimum resolution, and
tips on lighting and screen capture to ensure demos are clear and professional
for all participants.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good so far. Coderabbit suggested a tip I think is worth putting in there.
|
||
### For Hosts | ||
|
||
- Get familiarized with the hosting platform (Restream) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[suggestion]: I think CodeRabbit made a good point with the ratio suggestion @derberg. It’ll ensure that hosts create effect videos. What do you think?
- Get familiarized with the hosting platform (Restream) | |
- Get familiarized with the hosting platform (Restream) | |
- Ensure video is in 16:9 aspect ratio (1080p recommended) and demos are clearly visible (proper lighting and screen capture tools). |
@iambami please update the pr with the pending reviews |
Hello everyone 👋
Given our discussion, here is a draft of the webinar series initiative.
Go through it and drop your reviews.
cc/ @derberg @thulieblack @TRohit20 @AceTheCreator
Summary by CodeRabbit