docs: add publishing podcasts document to the community docs #2034
Conversation
ezinneanne
requested review from
bandantonio,
derberg,
asyncapi-bot-eve and
thulieblack
as code owners
WalkthroughAdds a new documentation page describing how to publish AsyncAPI meetings as podcasts via a GitHub Actions workflow and Spotify for Podcasters, covering prerequisites, acceptable YouTube URL formats, who can trigger the workflow, required inputs, and post-upload editing steps. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Maintainer as Maintainer (write access)
participant GH as GitHub Actions<br/>"Upload Episode from YouTube To Spotify for Podcasters"
participant YT as YouTube
participant SP as Spotify for Podcasters
Maintainer->>GH: Trigger workflow with YouTube video ID/URL
GH->>YT: Fetch video and extract audio
GH->>SP: Upload episode payload (audio + metadata)
SP-->>Maintainer: Episode appears in dashboard
note over Maintainer,SP: Post-upload: edit title, description, episode type, season/episode numbers
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested labels
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests
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. Comment |
ezinneanne
changed the title
|
@thulieblack I made a new document for the podcast doc and the meetings-organization doc may need pictures of restream as they have made UI updates. Kindy review @bandantonio @derberg |
|
documents are empty @ezinneanne |
|
Thank you @thulieblack I have updated it. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (7)
docs/060-meetings-and-communication/publishing-podcasts.md (7)
17-17: Use correct product name and link (and avoid code formatting).Use “Spotify for Podcasters” (lowercase “for”), remove code formatting, and link to the site.
- - The goal is to upload our AsyncAPI video/live streams on `Spotify For Podcasters` platform, ultimately allowing the listener to play the episodes on Spotify. Almost every YouTube video can be converted into a podcast. + - The goal is to upload our AsyncAPI videos/livestreams on [Spotify for Podcasters](https://podcasters.spotify.com), ultimately allowing listeners to play the episodes on Spotify. Almost every YouTube video can be converted into a podcast.
22-22: Avoid assuming default branch; rephrase permissions and verify branch name.Default branches are often “main” now. Suggest rewording to repo write access and verify the actual default branch name.
- - The workflow can only be triggered by a person with write access to the `master` branch of the `asyncapi/community` repository. + - The workflow can only be triggered by a person with write access to the `asyncapi/community` repository.Please confirm whether the default branch is “main” or “master” and update if the branch is relevant to triggering the workflow.
26-28: Add a prerequisite about consent and compliance.Publishing meeting audio requires consent and adherence to guidelines. Add this as an explicit prerequisite.
- The YouTube video ID is needed to trigger the workflow. + - The YouTube video ID is needed to trigger the workflow. + - Ensure you have permission from all meeting participants to publish the audio and that the content complies with our Code of Conduct and privacy guidelines.I can add links to the repo’s CoC/privacy docs if you share their paths.
35-37: Fix bare URL and tighten wording.Wrap the URL in autolinks to satisfy MD034 and simplify the sentence.
- Let's take this video link, for example: https://www.youtube.com/watch?v=3rg_7hIb9PQ. + Let's take this video link, for example: <https://www.youtube.com/watch?v=3rg_7hIb9PQ>. @@ - Here the video ID is the word/entity after `https://www.youtube.com/watch?v=`, i.e., `3rg_7hIb9PQ` + Here, the video ID is the substring after `https://www.youtube.com/watch?v=`, i.e., `3rg_7hIb9PQ`.
68-70: Tighten punctuation and tone in steps.Improve readability by removing extra punctuation and informal phrasing.
-6. Click on `Run workflow` button. -7. Wait for the workflow to finish. (Depending on video size, it may take some time to upload, so please have patience. Thank you.) . -8. A few moments later....Hurray! Your episode is now uploaded successfully! +6. Click on the `Run workflow` button. +7. Wait for the workflow to finish. Depending on the video size, the upload may take some time, so please be patient. +8. Once the workflow completes, your episode will be uploaded successfully.
73-76: Fix bare URL, grammar, and numbering in post-upload steps.
- Wrap bare URL (MD034).
- Use “Log in” (verb).
- Correct list numbering.
-1. Go to https://podcasters.spotify.com/. -2. Login using AsyncAPI account. -2. Go to `Episodes` section. There, you will see your latest upload. -3. Perform edits and save them. +1. Go to <https://podcasters.spotify.com/>. +2. Log in using the AsyncAPI account. +3. Go to the `Episodes` section. There, you will see your latest upload. +4. Perform edits and save them.
62-66: Consider linking directly to the workflow for discoverability.Add a link to the workflow in the repo so readers can click straight to it.
For example, append a line like:
- Or open the workflow directly: Upload Episode from YouTube To Spotify for Podcasters
Please replace with the actual relative path to the workflow file.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/060-meetings-and-communication/publishing-podcasts.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/060-meetings-and-communication/publishing-podcasts.md
35-35: Bare URL used
(MD034, no-bare-urls)
43-43: Bare URL used
(MD034, no-bare-urls)
45-45: Bare URL used
(MD034, no-bare-urls)
47-47: Bare URL used
(MD034, no-bare-urls)
49-49: Bare URL used
(MD034, no-bare-urls)
51-51: Bare URL used
(MD034, no-bare-urls)
53-53: Bare URL used
(MD034, no-bare-urls)
55-55: Bare URL used
(MD034, no-bare-urls)
73-73: Bare URL used
(MD034, no-bare-urls)
| - `https://www.youtube.com/watch?v=VIDEO_ID` | ||
| - Here, it can be https://www.youtube.com/watch?v=3rg_7hIb9PQ | ||
| - `https://youtu.be/VIDEO_ID` | ||
| - Here, it can be https://www.youtu.be/3rg_7hIb9PQ | ||
| - `https://www.youtube.com/embed/VIDEO_ID` | ||
| - Here, it can be https://www.youtube.com/embed/3rg_7hIb9PQ | ||
| - `https://www.youtube.com/playlist?list=PLAYLIST_ID` | ||
| - Here, it can be https://www.youtube.com/playlist?list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6 | ||
| - `https://www.youtube.com/shorts/VIDEO_ID` | ||
| - Here, it can be https://www.youtube.com/shorts/3rg_7hIb9PQ | ||
| - `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` | ||
| - Here, it can be https://www.youtube.com/watch?v=deLUAobdVpw&list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6 | ||
| - `https://youtube.com/shorts/VIDEO_ID?feature=share` | ||
| - Here, it can be https://youtube.com/shorts/U5jUr8XAF_M?feature=share | ||
|
|
There was a problem hiding this comment.
Wrap bare URLs in examples and fix invalid youtu.be domain.
- Address MD034 by autolinking example URLs.
- “www.youtu.be” is invalid; use “https://youtu.be/…”.
- `https://www.youtube.com/watch?v=VIDEO_ID`
- - Here, it can be https://www.youtube.com/watch?v=3rg_7hIb9PQ
+ - Here, it can be <https://www.youtube.com/watch?v=3rg_7hIb9PQ>
- `https://youtu.be/VIDEO_ID`
- - Here, it can be https://www.youtu.be/3rg_7hIb9PQ
+ - Here, it can be <https://youtu.be/3rg_7hIb9PQ>
- `https://www.youtube.com/embed/VIDEO_ID`
- - Here, it can be https://www.youtube.com/embed/3rg_7hIb9PQ
+ - Here, it can be <https://www.youtube.com/embed/3rg_7hIb9PQ>
- - `https://www.youtube.com/playlist?list=PLAYLIST_ID`
- - Here, it can be https://www.youtube.com/playlist?list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6
+ - `https://www.youtube.com/playlist?list=PLAYLIST_ID`
+ - Here, it can be <https://www.youtube.com/playlist?list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6>
- `https://www.youtube.com/shorts/VIDEO_ID`
- - Here, it can be https://www.youtube.com/shorts/3rg_7hIb9PQ
+ - Here, it can be <https://www.youtube.com/shorts/3rg_7hIb9PQ>
- `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID`
- - Here, it can be https://www.youtube.com/watch?v=deLUAobdVpw&list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6
+ - Here, it can be <https://www.youtube.com/watch?v=deLUAobdVpw&list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6>
- `https://youtube.com/shorts/VIDEO_ID?feature=share`
- - Here, it can be https://youtube.com/shorts/U5jUr8XAF_M?feature=share
+ - Here, it can be <https://youtube.com/shorts/U5jUr8XAF_M?feature=share>📝 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.
| - `https://www.youtube.com/watch?v=VIDEO_ID` | |
| - Here, it can be https://www.youtube.com/watch?v=3rg_7hIb9PQ | |
| - `https://youtu.be/VIDEO_ID` | |
| - Here, it can be https://www.youtu.be/3rg_7hIb9PQ | |
| - `https://www.youtube.com/embed/VIDEO_ID` | |
| - Here, it can be https://www.youtube.com/embed/3rg_7hIb9PQ | |
| - `https://www.youtube.com/playlist?list=PLAYLIST_ID` | |
| - Here, it can be https://www.youtube.com/playlist?list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6 | |
| - `https://www.youtube.com/shorts/VIDEO_ID` | |
| - Here, it can be https://www.youtube.com/shorts/3rg_7hIb9PQ | |
| - `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` | |
| - Here, it can be https://www.youtube.com/watch?v=deLUAobdVpw&list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6 | |
| - `https://youtube.com/shorts/VIDEO_ID?feature=share` | |
| - Here, it can be https://youtube.com/shorts/U5jUr8XAF_M?feature=share | |
| - `https://www.youtube.com/watch?v=VIDEO_ID` | |
| - Here, it can be <https://www.youtube.com/watch?v=3rg_7hIb9PQ> | |
| - `https://youtu.be/VIDEO_ID` | |
| - Here, it can be <https://youtu.be/3rg_7hIb9PQ> | |
| - `https://www.youtube.com/embed/VIDEO_ID` | |
| - Here, it can be <https://www.youtube.com/embed/3rg_7hIb9PQ> | |
| - `https://www.youtube.com/playlist?list=PLAYLIST_ID` | |
| - Here, it can be <https://www.youtube.com/playlist?list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6> | |
| - `https://www.youtube.com/shorts/VIDEO_ID` | |
| - Here, it can be <https://www.youtube.com/shorts/3rg_7hIb9PQ> | |
| - `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` | |
| - Here, it can be <https://www.youtube.com/watch?v=deLUAobdVpw&list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6> | |
| - `https://youtube.com/shorts/VIDEO_ID?feature=share` | |
| - Here, it can be <https://youtube.com/shorts/U5jUr8XAF_M?feature=share> |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
43-43: Bare URL used
(MD034, no-bare-urls)
45-45: Bare URL used
(MD034, no-bare-urls)
47-47: Bare URL used
(MD034, no-bare-urls)
49-49: Bare URL used
(MD034, no-bare-urls)
51-51: Bare URL used
(MD034, no-bare-urls)
53-53: Bare URL used
(MD034, no-bare-urls)
55-55: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In docs/060-meetings-and-communication/publishing-podcasts.md around lines 42 to
56, the example URLs are bare (triggering MD034) and one entry uses the invalid
domain "www.youtu.be"; update the examples by autolinking each URL (wrap each
example URL in <> so they render as links) and replace "https://www.youtu.be/…"
with the correct short-domain form "https://youtu.be/…", keeping all other
example URLs unchanged and ensuring consistent https scheme.
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (2)
84-86: Incomplete sentence in “Restream-first” introduction.The sentence ending with “It is because by” is unfinished and confusing.
Apply this diff:
-You must start with YouTube first, even though Restream can directly stream there. It is because by +You must start with YouTube first, even though Restream can stream there directly. This ensures you enable closed captions on YouTube and can select the pre-created YouTube event inside Restream.
211-213: Fix non-canonical youtu.be example URL (remove www).The shortened domain is youtu.be (no www).
Apply this diff:
-- - Here, it can be https://www.youtu.be/3rg_7hIb9PQ +- - Here, it can be https://youtu.be/3rg_7hIb9PQ
🧹 Nitpick comments (3)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (3)
60-63: Tighten grammar, punctuation, and brand capitalization; make bullets consistent.
- “corresponds with” → “corresponds to”
- End each bullet with a period.
- Capitalize “YouTube.”
Apply this diff:
- - Title for the live stream that corresponds with the meeting you just started, - - Meeting description must be provided even if the field is empty; otherwise, the old one from other streams will be used. - - Add a thumbnail for the stream as platforms like Youtube require one. + - Title for the live stream that corresponds to the meeting you just started. + - Provide a meeting description. If you leave it empty, the previous description from other streams may be reused. + - Add a thumbnail for the stream; platforms like YouTube require one.Optional: add a note on recommended thumbnail specs (YouTube: 1280×720, 16:9, ≤2 MB) after this list.
178-244: Avoid duplicating the new “Publishing podcasts” guide; link to the dedicated page instead.This section repeats detailed workflow steps that now live in the new publishing-podcasts.md. Duplicated guidance will drift and confuse readers.
Apply this diff to replace the long section with a concise pointer (keeps this page focused and avoids maintenance drift):
-## How do I publish broadcasted meetings as podcasts? - -### Why do we need this feature? -... -3. Perform edits and save them. +## How do I publish broadcasted meetings as podcasts? + +See the dedicated guide: [Publishing podcasts](./publishing-podcasts.md) for: +- Who can trigger the upload workflow. +- How to find and provide a YouTube video ID (with URL examples). +- Step-by-step: running “Upload Episode from YouTube to Spotify for Podcasters” in GitHub Actions. +- Post-upload edits in Spotify for Podcasters.If you prefer to keep a teaser here, we can leave a two-sentence summary above the link.
240-243: Verb choice and step numbering polish.Use “Log in” (verb) instead of “Login” (noun). Also consider letting Markdown auto-number steps by using “1.” for each item.
Apply this diff:
-1. Go to https://podcasters.spotify.com/. -2. Login using AsyncAPI account. -2. Go to `Episodes` section. There, you will see your latest upload. -3. Perform edits and save them. +1. Go to https://podcasters.spotify.com/. +1. Log in using the AsyncAPI account. +1. Go to the `Episodes` section. You will see your latest upload there. +1. Perform edits and save them.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
⛔ Files ignored due to path filters (3)
assets/meetings/stream1.pngis excluded by!**/*.pngassets/meetings/stream2.pngis excluded by!**/*.pngassets/meetings/stream3.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
[grammar] ~60-~60: There might be a mistake here.
Context: ...sponds with the meeting you just started, - Meeting description must be provided eve...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...old one from other streams will be used. - Add a thumbnail for the stream as platfo...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
52-52: Images should have alternate text (alt text)
(MD045, no-alt-text)
56-56: Images should have alternate text (alt text)
(MD045, no-alt-text)
64-64: Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md (1)
50-52: Fix typo and improve Restream option label formattingThe Restream option should read “RTMP,” not “RMTP.” Added spacing around the pipe and after commas for readability, and corrected “vMix” capitalization.
• File:
docs/060-meetings-and-communication/MEETINGS_ORGANIZATION.md
Lines: 50–52-1. Log into [Restream.io](https://app.restream.io/home) and select `Encoder|RMTP (Stream from OBS,Zoom,VMix,etc.)` option: +1. Log into [Restream.io](https://app.restream.io/home) and select `Encoder | RTMP (Stream from OBS, Zoom, vMix, etc.)`:
| weight: 40 | ||
| --- | ||
|
|
||
|
|
|
|
||
| This document covers how to publish recorded AsyncAPI meetings as podcasts. | ||
|
|
||
| # FAQ |
There was a problem hiding this comment.
Is it a How-to document like you stated in the line 7 or FAQ?
|
|
||
| # FAQ | ||
|
|
||
| ## How do I publish broadcasted meetings as podcasts? |
There was a problem hiding this comment.
Duplication of line 7
Do you really need this heading?
| ## How do I publish broadcasted meetings as podcasts? |
|
|
||
| ## How do I publish broadcasted meetings as podcasts? | ||
|
|
||
| ### Why do we need this feature? |
There was a problem hiding this comment.
If we expect this to be a how-to document, it is assumed that readers already know this context and know why they need this feature. They only need instructions on how to do that.
So my questions are "Who is this document for? What are you trying to communicate?"
There was a problem hiding this comment.
the document is an FAQ
|
|
||
| ### Who can upload the videos? | ||
|
|
||
| - The workflow can only be triggered by a person with write access to the `master` branch of the `asyncapi/community` repository. |
There was a problem hiding this comment.
| - The workflow can only be triggered by a person with write access to the `master` branch of the `asyncapi/community` repository. | |
| Anyone with write access to the `asyncapi/community` repository’s `master` branch. |
| 5. Provide the YouTube ID in the box. | ||
| 6. Click on `Run workflow` button. | ||
| 7. Wait for the workflow to finish. (Depending on video size, it may take some time to upload, so please have patience. Thank you.) . | ||
| 8. A few moments later....Hurray! Your episode is now uploaded successfully! |
There was a problem hiding this comment.
This isn't a step
| 8. A few moments later....Hurray! Your episode is now uploaded successfully! |
| 7. Wait for the workflow to finish. (Depending on video size, it may take some time to upload, so please have patience. Thank you.) . | ||
| 8. A few moments later....Hurray! Your episode is now uploaded successfully! | ||
|
|
||
| You can also modify description and other information for uploaded podcast directly in Spotify: |
There was a problem hiding this comment.
| You can also modify description and other information for uploaded podcast directly in Spotify: | |
| (Optional) You can modify the description and other information for the uploaded podcast directly in Spotify: |
|
|
||
| 1. Go to https://podcasters.spotify.com/. | ||
| 2. Login using AsyncAPI account. | ||
| 2. Go to `Episodes` section. There, you will see your latest upload. |
There was a problem hiding this comment.
| 2. Go to `Episodes` section. There, you will see your latest upload. | |
| 2. Go to the 'Episodes' section to see your latest upload. |
| 1. Go to https://podcasters.spotify.com/. | ||
| 2. Login using AsyncAPI account. | ||
| 2. Go to `Episodes` section. There, you will see your latest upload. | ||
| 3. Perform edits and save them. |
There was a problem hiding this comment.
Should I click somewhere to enable edit mode?
| ### What is YouTube video ID? | ||
|
|
||
| - A YouTube video ID is a unique combination of characters that identifies a specific video on the YouTube platform. It's used in the URL of the video to direct users to the exact video they want to watch. The video ID is typically a sequence of letters, numbers, and special characters that generally comes after the "v=" parameter in the URL. | ||
| - [More examples](#list-of-different-types-of-youtube-links) of video ID are given below: ⬇️ |
There was a problem hiding this comment.
There is some redundant info between lines 28-57. I would cut it off and add it as a tip rather than separate sections because it is supplemental information and
everyone who knows what video ID is and where to find it could easily skip through it and proceed further with the instructions.
Furthermore, Coderabbit made a very important comment which answered my question that I was going to ask about supported/unsupported formats and the fact that you only need an ID, not the full URL. It is very important and should be mentioned in the note.
| ### What is YouTube video ID? | |
| - A YouTube video ID is a unique combination of characters that identifies a specific video on the YouTube platform. It's used in the URL of the video to direct users to the exact video they want to watch. The video ID is typically a sequence of letters, numbers, and special characters that generally comes after the "v=" parameter in the URL. | |
| - [More examples](#list-of-different-types-of-youtube-links) of video ID are given below: ⬇️ | |
| <Remember> | |
| **What is YouTube video ID?** | |
| The video ID is an 11-character alphanumeric string that uniquely identifies a YouTube video. | |
| ID is usually the last part of the URL after `v=` or separated by a forward slash (`/`): | |
| - https://www.youtube.com/watch?v=VIDEO_ID | |
| - https://www.youtu.be/VIDEO_ID | |
| - https://www.youtube.com/shorts/VIDEO_ID | |
| - https://www.youtube.com/embed/VIDEO_ID | |
| You may also find URLs with a video in a playlist: `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` | |
| Here, video ID is located between `?v=` and `&list=` URL parameters. | |
| **This workflow accepts only the YouTube *video ID*, not a full URL or playlist. You need to extract the `VIDEO_ID` and provide it as an input.** | |
| </Remember> |
|
@bandantonio I have added the changes. Kindly review |
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/060-meetings-and-communication/publishing-podcasts.md (1)
49-62: Wrap bare URLs and fix invalid youtu.be domain; annotate unsupported inputs.
- Address MD034 by autolinking “Here, it can be …” examples.
- Replace “www.youtu.be” with “youtu.be”.
- Clarify playlist and “watch?v=…&list=…” forms aren’t accepted as input.
- `https://www.youtube.com/watch?v=VIDEO_ID` - - Here, it can be https://www.youtube.com/watch?v=3rg_7hIb9PQ + - Here, it can be <https://www.youtube.com/watch?v=3rg_7hIb9PQ> - `https://youtu.be/VIDEO_ID` - - Here, it can be https://www.youtu.be/3rg_7hIb9PQ + - Here, it can be <https://youtu.be/3rg_7hIb9PQ> - `https://www.youtube.com/embed/VIDEO_ID` - - Here, it can be https://www.youtube.com/embed/3rg_7hIb9PQ + - Here, it can be <https://www.youtube.com/embed/3rg_7hIb9PQ> - `https://www.youtube.com/playlist?list=PLAYLIST_ID` - - Here, it can be https://www.youtube.com/playlist?list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6 + - Here, it can be <https://www.youtube.com/playlist?list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6> (**not supported** as input) - `https://www.youtube.com/shorts/VIDEO_ID` - - Here, it can be https://www.youtube.com/shorts/3rg_7hIb9PQ + - Here, it can be <https://www.youtube.com/shorts/3rg_7hIb9PQ> - `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` - - Here, it can be https://www.youtube.com/watch?v=deLUAobdVpw&list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6 + - Here, it can be <https://www.youtube.com/watch?v=deLUAobdVpw&list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6> (**not supported** — extract and use `VIDEO_ID` only) - `https://youtube.com/shorts/VIDEO_ID?feature=share` - - Here, it can be https://youtube.com/shorts/U5jUr8XAF_M?feature=share + - Here, it can be <https://youtube.com/shorts/U5jUr8XAF_M?feature=share>
🧹 Nitpick comments (5)
docs/060-meetings-and-communication/publishing-podcasts.md (5)
6-9: Consolidate headings and tighten intro (align with FAQ intent).Two headings (“FAQ” and “Publishing recorded…”) are redundant, and the intro sentence is wordy and uses an unnecessary semicolon. Since this is an FAQ, make a single clear H2 and streamline the intro.
-# FAQ - -## Publishing recorded meetings as podcasts on AsyncAPI -This document covers FAQs on publishing recorded AsyncAPI meetings as podcasts. It is intended to guide any AsyncAPI member who has the rights/access to stream and record meetings; on how to publish the recorded meetings as podcasts. For more information on streaming and recording meetings, check the [Meetings-Organization](https://www.asyncapi.com/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION) document. +## FAQ: Publishing recorded meetings as podcasts +This FAQ explains how to publish recorded AsyncAPI meetings as podcasts. It is intended for AsyncAPI members who have rights to stream and record meetings. For more on streaming and recording meetings, see the [Meetings Organization](https://www.asyncapi.com/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION) document.
15-16: Brand style: “Spotify for Podcasters” capitalization.Use the official brand casing (“for” lowercased). Also consider softening “Almost every YouTube video can be converted…” to avoid overpromising.
-- The goal is to upload our AsyncAPI video/live streams on `Spotify For Podcasters` platform, ultimately allowing the listener to play the episodes on Spotify. Almost every YouTube video can be converted into a podcast. +- The goal is to upload our AsyncAPI videos/live streams on the `Spotify for Podcasters` platform, ultimately allowing listeners to play the episodes on Spotify. Most YouTube videos can be converted into a podcast, subject to eligibility and rights.
38-45: Autolink the example and tighten phrasing.Wrap the demo link in angle brackets and phrase the explanation succinctly.
-#### How to find YouTube ID? - -Let's take this video link, for example: https://www.youtube.com/watch?v=3rg_7hIb9PQ. - -Here the video ID is the word/entity after `https://www.youtube.com/watch?v=`, i.e., `3rg_7hIb9PQ` +#### How to find a YouTube video ID + +For example, see <https://www.youtube.com/watch?v=3rg_7hIb9PQ>. + +The video ID is the part after `v=` → `3rg_7hIb9PQ`.
73-78: Polish post‑upload steps and fix bare URL.
- Use “Log in” (verb) rather than “Login” (noun).
- Autolink the URL.
- Minor wording tweaks for clarity.
-(Optional) You can modify the description and other information for the uploaded podcast directly in Spotify: -1. Go to https://creators.spotify.com/. -2. Login using AsyncAPI account. -3. Go to the 'Episodes' section to see your latest upload. -4. Perform edits and save them. +(Optional) You can modify the description and other information for the uploaded podcast directly in Spotify for Podcasters: +1. Go to <https://creators.spotify.com/>. +2. Log in using the AsyncAPI account. +3. Open the Episodes section to see your latest upload. +4. Make your edits and save.
30-33: Autolink earlier example URLs to satisfy MD034.The early list of formats still uses bare URLs. Wrap them in angle brackets like later examples.
-- https://www.youtube.com/watch?v=VIDEO_ID -- https://www.youtu.be/VIDEO_ID -- https://www.youtube.com/shorts/VIDEO_ID -- https://www.youtube.com/embed/VIDEO_ID +- <https://www.youtube.com/watch?v=VIDEO_ID> +- <https://youtu.be/VIDEO_ID> +- <https://www.youtube.com/shorts/VIDEO_ID> +- <https://www.youtube.com/embed/VIDEO_ID>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
docs/060-meetings-and-communication/publishing-podcasts.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/060-meetings-and-communication/publishing-podcasts.md
[grammar] ~26-~26: There might be a mistake here.
Context: ...ded? - The YouTube video ID. ### What is YouTube video ID? >> **What is YouTube ...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...video ID. ### What is YouTube video ID? >> What is YouTube video ID? The video ID...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...### What is YouTube video ID? >> What is YouTube video ID? The video ID is an ...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...deo ID? >> What is YouTube video ID? The video ID is an 11-character alphanum...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ... or separated by a forward slash (/`): - https://www.youtube.com/watch?v=VIDEO_ID...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...https://www.youtube.com/watch?v=VIDEO_ID - https://www.youtu.be/VIDEO_ID - https://...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...VIDEO_ID - https://www.youtu.be/VIDEO_ID - https://www.youtube.com/shorts/VIDEO_ID ...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ... https://www.youtube.com/shorts/VIDEO_ID - https://www.youtube.com/embed/VIDEO_ID Y...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...- https://www.youtube.com/embed/VIDEO_ID You may also find URLs with a video in a...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...e.com/watch?v=VIDEO_ID&list=PLAYLIST_IDHere, video ID is located between?v=` ...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: .../watch?v=VIDEO_ID&list=PLAYLIST_IDHere, video ID is located between?v=and...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...tween ?v= and &list= URL parameters. **This workflow accepts only the YouTube...
(QB_NEW_EN)
[grammar] ~40-~40: There might be a mistake here.
Context: ...deo ID are given below: ⬇️ #### How to find YouTube ID? Let's take this video link...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ...y 2. Click on the Run Workflow button. 3. Provide the YouTube ID in the box. 4. Cl...
(QB_NEW_EN)
[grammar] ~70-~70: There might be a mistake here.
Context: ... box. 4. Click on Run workflow button. 5. Wait for the workflow to finish (It may ...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...y.com/. 2. Login using AsyncAPI account. 3. Go to the 'Episodes' section to see your...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
docs/060-meetings-and-communication/publishing-podcasts.md
30-30: Bare URL used
(MD034, no-bare-urls)
31-31: Bare URL used
(MD034, no-bare-urls)
32-32: Bare URL used
(MD034, no-bare-urls)
33-33: Bare URL used
(MD034, no-bare-urls)
42-42: Bare URL used
(MD034, no-bare-urls)
50-50: Bare URL used
(MD034, no-bare-urls)
52-52: Bare URL used
(MD034, no-bare-urls)
54-54: Bare URL used
(MD034, no-bare-urls)
56-56: Bare URL used
(MD034, no-bare-urls)
58-58: Bare URL used
(MD034, no-bare-urls)
60-60: Bare URL used
(MD034, no-bare-urls)
62-62: Bare URL used
(MD034, no-bare-urls)
74-74: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (3)
docs/060-meetings-and-communication/publishing-podcasts.md (3)
36-36: Nice: Explicitly stating that only the video ID is accepted.This line removes ambiguity and aligns the FAQ with the workflow input. Good call.
20-20: Default branch and permissions verified—no changes neededI’ve confirmed that the repository’s default branch is indeed master, and the “Upload Episode from YouTube To Spotify for Podcasters” workflow is only triggered via
workflow_dispatch, which by GitHub’s rules can be invoked by anyone with at least write access to the repo. The existing line is correct as written—no updates required.
65-72: Update workflow reference and input label in docsTo ensure readers can follow precisely, replace the placeholder name with the actual workflow and clarify the input field:
### Step-by-step procedure -1. Open the Upload Episode from YouTube To Spotify for Podcasters actions workflow in the `<repo name>` repository -2. Click on the `Run Workflow` button. -3. Provide the YouTube ID in the box. -4. Click on `Run workflow` button. -5. Wait for the workflow to finish (It may take some time to upload the video). +1. Open the “Upload Episode from YouTube To Spotify for Podcasters” workflow in the `asyncapi/community` repository (Actions tab). +2. Click the `Run workflow` button. +3. Enter the YouTube video ID in the `video_id` input field. +4. Click `Run workflow`. +5. Wait for the workflow to finish (it may take some time to upload and process the video).
- Workflow name confirmed as Upload Episode from YouTube To Spotify for Podcasters
- Dispatch input key is video_id, described in the workflow as “Enter YouTube video ID to upload on Spotify for Podcasters.”
| - The YouTube video ID. | ||
|
|
||
| ### What is YouTube video ID? | ||
| >> **What is YouTube video ID?** | ||
| The video ID is an 11-character alphanumeric string that uniquely identifies a YouTube video. | ||
| ID is usually the last part of the URL after `v=` or separated by a forward slash (`/`): | ||
| - https://www.youtube.com/watch?v=VIDEO_ID | ||
| - https://www.youtu.be/VIDEO_ID | ||
| - https://www.youtube.com/shorts/VIDEO_ID | ||
| - https://www.youtube.com/embed/VIDEO_ID | ||
| You may also find URLs with a video in a playlist: `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` | ||
| Here, video ID is located between `?v=` and `&list=` URL parameters. | ||
| **This workflow accepts only the YouTube *video ID*, not a full URL or playlist. You need to extract the `VIDEO_ID` and provide it as an input.** |
There was a problem hiding this comment.
Fix duplicate Q, invalid blockquote markup, and grammar; autolink examples; correct invalid youtu.be form.
- Remove the repeated question (line 27) and the “>>” which is not standard for callouts.
- Prefer “a/the YouTube video ID.”
- Wrap example URLs in angle brackets to satisfy MD034.
- Replace “https://www.youtu.be/…” with “https://youtu.be/…”.
-### What is YouTube video ID?
->> **What is YouTube video ID?**
+### What is a YouTube video ID?
The video ID is an 11-character alphanumeric string that uniquely identifies a YouTube video.
ID is usually the last part of the URL after `v=` or separated by a forward slash (`/`):
-- https://www.youtube.com/watch?v=VIDEO_ID
-- https://www.youtu.be/VIDEO_ID
-- https://www.youtube.com/shorts/VIDEO_ID
-- https://www.youtube.com/embed/VIDEO_ID
+- <https://www.youtube.com/watch?v=VIDEO_ID>
+- <https://youtu.be/VIDEO_ID>
+- <https://www.youtube.com/shorts/VIDEO_ID>
+- <https://www.youtube.com/embed/VIDEO_ID>
You may also find URLs with a video in a playlist: `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID`
Here, video ID is located between `?v=` and `&list=` URL parameters.
**This workflow accepts only the YouTube *video ID*, not a full URL or playlist. You need to extract the `VIDEO_ID` and provide it as an input.**📝 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.
| - The YouTube video ID. | |
| ### What is YouTube video ID? | |
| >> **What is YouTube video ID?** | |
| The video ID is an 11-character alphanumeric string that uniquely identifies a YouTube video. | |
| ID is usually the last part of the URL after `v=` or separated by a forward slash (`/`): | |
| - https://www.youtube.com/watch?v=VIDEO_ID | |
| - https://www.youtu.be/VIDEO_ID | |
| - https://www.youtube.com/shorts/VIDEO_ID | |
| - https://www.youtube.com/embed/VIDEO_ID | |
| You may also find URLs with a video in a playlist: `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` | |
| Here, video ID is located between `?v=` and `&list=` URL parameters. | |
| **This workflow accepts only the YouTube *video ID*, not a full URL or playlist. You need to extract the `VIDEO_ID` and provide it as an input.** | |
| - The YouTube video ID. | |
| ### What is a YouTube video ID? | |
| The video ID is an 11-character alphanumeric string that uniquely identifies a YouTube video. | |
| ID is usually the last part of the URL after `v=` or separated by a forward slash (`/`): | |
| - <https://www.youtube.com/watch?v=VIDEO_ID> | |
| - <https://youtu.be/VIDEO_ID> | |
| - <https://www.youtube.com/shorts/VIDEO_ID> | |
| - <https://www.youtube.com/embed/VIDEO_ID> | |
| You may also find URLs with a video in a playlist: `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` | |
| Here, video ID is located between `?v=` and `&list=` URL parameters. | |
| **This workflow accepts only the YouTube *video ID*, not a full URL or playlist. You need to extract the `VIDEO_ID` and provide it as an input.** |
🧰 Tools
🪛 LanguageTool
[grammar] ~26-~26: There might be a mistake here.
Context: ...ded? - The YouTube video ID. ### What is YouTube video ID? >> **What is YouTube ...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...video ID. ### What is YouTube video ID? >> What is YouTube video ID? The video ID...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...### What is YouTube video ID? >> What is YouTube video ID? The video ID is an ...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...deo ID? >> What is YouTube video ID? The video ID is an 11-character alphanum...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ... or separated by a forward slash (/`): - https://www.youtube.com/watch?v=VIDEO_ID...
(QB_NEW_EN)
[grammar] ~30-~30: There might be a mistake here.
Context: ...https://www.youtube.com/watch?v=VIDEO_ID - https://www.youtu.be/VIDEO_ID - https://...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ...VIDEO_ID - https://www.youtu.be/VIDEO_ID - https://www.youtube.com/shorts/VIDEO_ID ...
(QB_NEW_EN)
[grammar] ~32-~32: There might be a mistake here.
Context: ... https://www.youtube.com/shorts/VIDEO_ID - https://www.youtube.com/embed/VIDEO_ID Y...
(QB_NEW_EN)
[grammar] ~33-~33: There might be a mistake here.
Context: ...- https://www.youtube.com/embed/VIDEO_ID You may also find URLs with a video in a...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...e.com/watch?v=VIDEO_ID&list=PLAYLIST_IDHere, video ID is located between?v=` ...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: .../watch?v=VIDEO_ID&list=PLAYLIST_IDHere, video ID is located between?v=and...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...tween ?v= and &list= URL parameters. **This workflow accepts only the YouTube...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.17.2)
30-30: Bare URL used
(MD034, no-bare-urls)
31-31: Bare URL used
(MD034, no-bare-urls)
32-32: Bare URL used
(MD034, no-bare-urls)
33-33: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In docs/060-meetings-and-communication/publishing-podcasts.md around lines 24 to
36, remove the duplicated question and the nonstandard ">>" blockquote
indicator, fix grammar to use "a/the YouTube video ID" consistently, wrap the
example URLs in angle brackets to satisfy MD034 (autolink), and replace the
invalid "https://www.youtu.be/…" example with the correct "https://youtu.be/…"
form; ensure the paragraph ends by clearly stating that only the 11-character
video ID (not a full URL or playlist) should be supplied.
|
@bandantonio your review |
|
I have added the requested coderabbit changes |
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
docs/060-meetings-and-communication/publishing-podcasts.md (1)
48-61: Autolink all examples; fix invalid youtu.be domain; mark unsupported playlist formsAlso keep “video ID” phrasing consistent with earlier note.
- `https://www.youtube.com/watch?v=VIDEO_ID` - - Here, it can be https://www.youtube.com/watch?v=3rg_7hIb9PQ + - Here, it can be <https://www.youtube.com/watch?v=3rg_7hIb9PQ> - `https://youtu.be/VIDEO_ID` - - Here, it can be https://www.youtu.be/3rg_7hIb9PQ + - Here, it can be <https://youtu.be/3rg_7hIb9PQ> - `https://www.youtube.com/embed/VIDEO_ID` - - Here, it can be https://www.youtube.com/embed/3rg_7hIb9PQ + - Here, it can be <https://www.youtube.com/embed/3rg_7hIb9PQ> - `https://www.youtube.com/playlist?list=PLAYLIST_ID` - - Here, it can be https://www.youtube.com/playlist?list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6 + - Here, it can be <https://www.youtube.com/playlist?list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6> (not supported as input) - `https://www.youtube.com/shorts/VIDEO_ID` - - Here, it can be https://www.youtube.com/shorts/3rg_7hIb9PQ + - Here, it can be <https://www.youtube.com/shorts/3rg_7hIb9PQ> - `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` - - Here, it can be https://www.youtube.com/watch?v=deLUAobdVpw&list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6 + - Here, it can be <https://www.youtube.com/watch?v=deLUAobdVpw&list=PLbi1gRlP7piiaD67o1F4EOPoZztg2r8l6> (extract and use `VIDEO_ID` only) - `https://youtube.com/shorts/VIDEO_ID?feature=share` - - Here, it can be https://youtube.com/shorts/U5jUr8XAF_M?feature=share + - Here, it can be <https://youtube.com/shorts/U5jUr8XAF_M?feature=share>
🧹 Nitpick comments (4)
docs/060-meetings-and-communication/publishing-podcasts.md (4)
20-21: Clarify permission required to run the workflowRunning a workflow_dispatch typically needs Write permission to the repo, not specifically “write access to master.”
-- Anyone with write access to the `asyncapi/community` repository’s `master` branch. +- Anyone with Write permission to the `asyncapi/community` repository can run this workflow from the Actions tab.
66-70: Make step 1 actionable and standardize button casing; use “YouTube video ID” consistently[建议]
-1. Open the Upload Episode from YouTube To Spotify for Podcasters actions workflow in the `<repo name>` repository -2. Click on the `Run Workflow` button. -3. Provide the YouTube ID in the box. -4. Click on `Run workflow` button. +1. In the `asyncapi/community` repository, open the Actions tab and select the “Upload Episode from YouTube To Spotify for Podcasters” workflow. +2. Click the `Run workflow` button. +3. Provide the YouTube video ID in the input box. +4. Click the `Run workflow` button.
15-16: Branding/style: “Spotify for Podcasters” and avoid code formatting[建议]
-- The goal is to upload our AsyncAPI video/live streams on `Spotify For Podcasters` platform, ultimately allowing the listener to play the episodes on Spotify. Almost every YouTube video can be converted into a podcast. +- The goal is to upload our AsyncAPI videos/livestreams to Spotify for Podcasters, ultimately allowing listeners to play the episodes on Spotify. Almost every YouTube video can be converted into a podcast.
6-9: Avoid duplicated top-level titles; drop the extra “# FAQ”Front matter already supplies the page title. A second H1 can confuse navigation.
-# FAQ - -## Publishing recorded meetings as podcasts on AsyncAPI -This document covers FAQs on publishing recorded AsyncAPI meetings as podcasts. It is intended to guide any AsyncAPI member who has the rights/access to stream and record meetings; on how to publish the recorded meetings as podcasts. For more information on streaming and recording meetings, check the [Meetings-Organization](https://www.asyncapi.com/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION) document. +This FAQ covers publishing recorded AsyncAPI meetings as podcasts. It is intended to guide members who can stream and record meetings on how to publish the recordings as podcasts. For streaming/recording details, see the [Meetings-Organization](https://www.asyncapi.com/docs/community/060-meetings-and-communication/MEETINGS_ORGANIZATION) document.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/060-meetings-and-communication/publishing-podcasts.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/060-meetings-and-communication/publishing-podcasts.md
29-29: Bare URL used
(MD034, no-bare-urls)
30-30: Bare URL used
(MD034, no-bare-urls)
31-31: Bare URL used
(MD034, no-bare-urls)
32-32: Bare URL used
(MD034, no-bare-urls)
41-41: Bare URL used
(MD034, no-bare-urls)
49-49: Bare URL used
(MD034, no-bare-urls)
51-51: Bare URL used
(MD034, no-bare-urls)
53-53: Bare URL used
(MD034, no-bare-urls)
55-55: Bare URL used
(MD034, no-bare-urls)
57-57: Bare URL used
(MD034, no-bare-urls)
59-59: Bare URL used
(MD034, no-bare-urls)
61-61: Bare URL used
(MD034, no-bare-urls)
73-73: Bare URL used
(MD034, no-bare-urls)
| - https://www.youtube.com/watch?v=VIDEO_ID | ||
| - https://youtu.be/VIDEO_ID | ||
| - https://www.youtube.com/shorts/VIDEO_ID | ||
| - https://www.youtube.com/embed/VIDEO_ID | ||
| You may also find URLs with a video in a playlist: `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` | ||
| Here, video ID is located between `?v=` and `&list=` URL parameters. | ||
| **This workflow accepts only the YouTube *video ID*, not a full URL or playlist. You need to extract the `VIDEO_ID` and provide it as an input.** |
There was a problem hiding this comment.
Fix MD034 bare URLs and tighten wording in “What is a YouTube video ID?”
Wrap examples in angle brackets, and keep “YouTube video ID” phrasing consistent.
- ID is usually the last part of the URL after `v=` or separated by a forward slash (`/`):
-- https://www.youtube.com/watch?v=VIDEO_ID
-- https://youtu.be/VIDEO_ID
-- https://www.youtube.com/shorts/VIDEO_ID
-- https://www.youtube.com/embed/VIDEO_ID
+ ID is usually the last part of the URL after `v=` or separated by a forward slash (`/`):
+ - <https://www.youtube.com/watch?v=VIDEO_ID>
+ - <https://youtu.be/VIDEO_ID>
+ - <https://www.youtube.com/shorts/VIDEO_ID>
+ - <https://www.youtube.com/embed/VIDEO_ID>
- You may also find URLs with a video in a playlist: `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID`
- Here, video ID is located between `?v=` and `&list=` URL parameters.
- **This workflow accepts only the YouTube *video ID*, not a full URL or playlist. You need to extract the `VIDEO_ID` and provide it as an input.**
+ You may also find URLs with a video in a playlist: `<https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID>`.
+ Here, the video ID is located between `?v=` and `&list=` URL parameters.
+ **This workflow accepts only the YouTube video ID, not a full URL or playlist. Extract the `VIDEO_ID` and provide it as input.**📝 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.
| - https://www.youtube.com/watch?v=VIDEO_ID | |
| - https://youtu.be/VIDEO_ID | |
| - https://www.youtube.com/shorts/VIDEO_ID | |
| - https://www.youtube.com/embed/VIDEO_ID | |
| You may also find URLs with a video in a playlist: `https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID` | |
| Here, video ID is located between `?v=` and `&list=` URL parameters. | |
| **This workflow accepts only the YouTube *video ID*, not a full URL or playlist. You need to extract the `VIDEO_ID` and provide it as an input.** | |
| ID is usually the last part of the URL after `v=` or separated by a forward slash (`/`): | |
| - <https://www.youtube.com/watch?v=VIDEO_ID> | |
| - <https://youtu.be/VIDEO_ID> | |
| - <https://www.youtube.com/shorts/VIDEO_ID> | |
| - <https://www.youtube.com/embed/VIDEO_ID> | |
| You may also find URLs with a video in a playlist: <https://www.youtube.com/watch?v=VIDEO_ID&list=PLAYLIST_ID>. | |
| Here, the video ID is located between `?v=` and `&list=` URL parameters. | |
| **This workflow accepts only the YouTube video ID, not a full URL or playlist. Extract the `VIDEO_ID` and provide it as input.** |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
29-29: Bare URL used
(MD034, no-bare-urls)
30-30: Bare URL used
(MD034, no-bare-urls)
31-31: Bare URL used
(MD034, no-bare-urls)
32-32: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In docs/060-meetings-and-communication/publishing-podcasts.md around lines 29 to
35, the examples show bare YouTube URLs and inconsistent phrasing; wrap each
example URL in angle brackets to satisfy MD034 (avoid bare URLs) and normalize
wording to consistently use "YouTube video ID" (not variations like "video ID");
also clarify the playlist example by indicating where the YouTube video ID is
located (between ?v= and &list=) and emphasize that only the video ID should be
provided as input.
| Let's take this video link, for example: https://www.youtube.com/watch?v=3rg_7hIb9PQ. | ||
|
|
||
| Here the video ID is the word/entity after `https://www.youtube.com/watch?v=`, i.e., `3rg_7hIb9PQ` | ||
|
|
There was a problem hiding this comment.
Autolink the example and format the extracted ID
-Let's take this video link, for example: https://www.youtube.com/watch?v=3rg_7hIb9PQ.
+Let's take this video link, for example: <https://www.youtube.com/watch?v=3rg_7hIb9PQ>.
-Here the video ID is the word/entity after `https://www.youtube.com/watch?v=`, i.e., `3rg_7hIb9PQ`
+Here the video ID is the part after `https://www.youtube.com/watch?v=`, i.e., `3rg_7hIb9PQ`.📝 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.
| Let's take this video link, for example: https://www.youtube.com/watch?v=3rg_7hIb9PQ. | |
| Here the video ID is the word/entity after `https://www.youtube.com/watch?v=`, i.e., `3rg_7hIb9PQ` | |
| Let's take this video link, for example: <https://www.youtube.com/watch?v=3rg_7hIb9PQ>. | |
| Here the video ID is the part after `https://www.youtube.com/watch?v=`, i.e., `3rg_7hIb9PQ`. |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
41-41: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In docs/060-meetings-and-communication/publishing-podcasts.md around lines 41 to
44, the plain URL example should be made clickable and the extracted video ID
should be formatted as inline code; replace the raw URL with a Markdown/autolink
(e.g., <https://www.youtube.com/watch?v=3rg_7hIb9PQ> or a standard Markdown
link) and wrap the ID 3rg_7hIb9PQ in inline code formatting so it stands out as
an extracted identifier.
| 1. Go to https://creators.spotify.com/. | ||
| 2. Login using AsyncAPI account. | ||
| 3. Go to the 'Episodes' section to see your latest upload. | ||
| 4. Perform edits and save them. |
There was a problem hiding this comment.
Autolink external URL; minor wording tweaks
-1. Go to https://creators.spotify.com/.
-2. Login using AsyncAPI account.
+1. Go to <https://creators.spotify.com/>.
+2. Log in using the AsyncAPI account.📝 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.
| 1. Go to https://creators.spotify.com/. | |
| 2. Login using AsyncAPI account. | |
| 3. Go to the 'Episodes' section to see your latest upload. | |
| 4. Perform edits and save them. | |
| 1. Go to <https://creators.spotify.com/>. | |
| 2. Log in using the AsyncAPI account. | |
| 3. Go to the 'Episodes' section to see your latest upload. | |
| 4. Perform edits and save them. |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
73-73: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In docs/060-meetings-and-communication/publishing-podcasts.md around lines 73 to
76, the step list should autolink the external URL and use clearer wording:
replace the plain URL with a Markdown autolink for
https://creators.spotify.com/, change "Login" to "Log in" and specify "using the
AsyncAPI account", change "Go to the 'Episodes' section to see your latest
upload." to "Open the Episodes section to view your latest episode." and change
"Perform edits and save them." to "Edit the episode metadata or content as
needed, then save your changes."
Description
Related issue(s)
See also #1986Summary by CodeRabbit