Skip to content

Commit

Permalink
Merge branch 'asyncapi:master' into style-guide-grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
Arya-Gupta authored Dec 5, 2023
2 parents d44f9e1 + 1547693 commit 0054c57
Show file tree
Hide file tree
Showing 17 changed files with 210 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/automerge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:
env:
GITHUB_TOKEN: "${{ secrets.GH_TOKEN }}"
GITHUB_LOGIN: asyncapi-bot
MERGE_LABELS: ""
MERGE_LABELS: "!do-not-merge"
MERGE_METHOD: "squash"
MERGE_COMMIT_MESSAGE: "{pullRequest.title} (#{pullRequest.number})"
MERGE_RETRIES: "20"
Expand Down
36 changes: 36 additions & 0 deletions .github/workflows/youtube-to-spotify-for-podcasters.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: 'Upload Episode from YouTube To Spotify for Podcasters'

on:
workflow_dispatch:
inputs:
video_id:
description: 'Enter YouTube video ID to upload on Spotify for Podcasters.'
required: true

jobs:
upload_episode:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Create episode.json file
run: |
# Get the video ID from the workflow_dispatch input.
video_id="${{ github.event.inputs.video_id }}"
# Create episode.json content with the video ID
json_content="{\"id\": \"${video_id}\"}"
# Write the content to episode.json in the workspace directory
echo "${json_content}" > episode.json
# Verify the content was written successfully
cat episode.json
- name: Upload Episode from YouTube To Anchor.Fm
uses: Schrodinger-Hat/youtube-to-anchorfm@c722f3edeee94f3173dad36c5a959247973c5253 #commit related to https://github.com/Schrodinger-Hat/youtube-to-anchorfm/commit/c722f3edeee94f3173dad36c5a959247973c5253 || The latest commit which is of Nov 14, 2023
env:
ANCHOR_EMAIL: ${{ secrets.ANCHOR_EMAIL }}
ANCHOR_PASSWORD: ${{ secrets.ANCHOR_PASSWORD }}
EPISODE_PATH: /github/workspace
URL_IN_DESCRIPTION: true
LOAD_THUMBNAIL: true
POSTPROCESSOR_ARGS: 'ffmpeg:-ac 1'
2 changes: 1 addition & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/.

# The default owners are automatically added as reviewers when you open a pull request unless different owners are specified in the file.
* @fmvilas @alequetzalli @derberg @asyncapi-bot-eve @thulieblack
* @alequetzalli @derberg @asyncapi-bot-eve @thulieblack

# All ambassadors related files
AMBASSADOR* @Barbanio
2 changes: 1 addition & 1 deletion Emeritus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
emeritus:
- jotamusik
- LouisXhaferi
- aeworxet
- aeworxet
9 changes: 9 additions & 0 deletions MAINTAINERS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,15 @@
isTscMember: true
repos:
- jasyncapi-idea-plugin
- name: Prince Rajpoot
github: princerajpoot20
linkedin: princerajpoot
slack: U04STTQHV18
twitter: iamPrince_2003
availableForHire: true
isTscMember: true
repos:
- studio
- name: Richard Coppen
github: rcoppen
linkedin: richard-coppen
Expand Down
109 changes: 89 additions & 20 deletions MEETINGS_ORGANIZATION.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
This document covers the aspect of different meetings organization at AsyncAPI.
This document covers the aspects of different meeting organizations at AsyncAPI.

## FAQ

### What do I need to schedule a meeting?

To schedule a meeting, you need to be:
- one of the licensed Zoom users associated with the AsyncAPI Zoom account. It is required because only licensed users can start meeting, live transcripts, and streaming.
- one of the licensed Zoom users associated with the AsyncAPI Zoom account. It is required because only licensed users can start meetings, live transcripts, and streaming.
- GitHub Action workflow for `Ad Hoc` meeting scheduling should be updated. Newly licensed users should be added as alternative hosts.
- a member of [GitHub team called meetings-organizars](https://github.com/orgs/asyncapi/teams/meetings-organizers). It is required because only maintainers of the given repository can manually trigger GitHub Actions workflows. This group has a `Maintain` role in the `community` repository where meeting automation is implemented.
- a member of a team in the AsyncAPI Restream account. It is required because hosts must log in to Restream before they start streaming the meeting from Zoom and modify the stream's title that will show up on social platforms.
- a member of the AsyncAPI YouTube account. It is required because after the meeting is over, hosts need to add live their stream recording to the proper YouTube Playlist to improve recording discoverability.
- a member of [GitHub team called meetings-organizers](https://github.com/orgs/asyncapi/teams/meetings-organizers). This is required because only repository maintainers can manually trigger GitHub Actions workflows. This group has a `Maintain` role in the `community` repository where meeting automation is implemented.
- a member of a team in the AsyncAPI Restream account. It is required because hosts must log in to Restream before streaming the meeting from Zoom and modify the stream's title that will appear on social platforms.
- a member of the AsyncAPI YouTube account. It is required because hosts need to add live stream recordings to the proper YouTube Playlist after the meeting is over to improve recording discoverability.

### What meetings do we have?

Expand All @@ -25,16 +25,16 @@ To schedule a meeting, you need to be:

We have an automated workflow in place:
1. Automation starts after clicking **Run workflow**. (Unless there is another GitHub Actions outage and proper events are not delivered to automation :smiley: )
1. It creates a new meeting in Zoom. It is by default configured to support live streaming
1. It creates a new meeting in Zoom. It is, by default, configured to support live streaming
1. It creates a GitHub issue with all details about the meeting
1. It creates a new Google Calendar entry with special metadata containing the GitHub issue number
1. It sends a tweet with information about a newly scheduled event

### What are my responsibilities as meeting host?

Technically there are two types of meetings:
- Zoom-first: Meeting takes place on Zoom and through integration with Restream.io it is streamed to different channels. These meetings happen on Zoom to enable as many people as possible to join live conversation.
- Restream-first: Meeting takes place on Restream and is is streamed to different channels. These meetings are focused on showing or explaining some topic without live audio conversation with the audience.
Technically, there are two types of meetings:
- Zoom-first: The meeting takes place on Zoom and is streamed to different channels through integration with Restream.io. The goal is to enable as many people as possible to join the live conversation.
- Restream-first: The meeting takes place on Restream and is streamed to different channels. These meetings are focused on showing or explaining some topic without a live audio conversation with the audience.

#### Zoom-first

Expand All @@ -53,7 +53,7 @@ This is what you need to do to kick it off:
1. Provide title and description:

- 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.
- Meeting description must be provided even if the field is empty; otherwise, the old one from other streams will be used.

<img src="assets/meetings/restream3.png" width="50%">

Expand All @@ -75,23 +75,23 @@ This is what you need to do to kick it off:

#### Restream-first

You need to first start with YouTube, even though Restream can directly stream there. It is because by
You must start with YouTube first, even though Restream can directly stream there. It is because by

This is what you need to do to kick it off:

1. In [YouTube](https://youtube.com) click on your profile picture and select `Switch account`:
1. In [YouTube](https://youtube.com), click on your profile picture and select `Switch account`:

<img src="assets/meetings/yt1.png" width="40%">

1. Select `AsyncAPI`. If you do not see it on the list, means you did not have all access rights needed to setup a live stream:
1. Select `AsyncAPI`. If you do not see it on the list, it means you did not have all the access rights needed to set up a live stream:

<img src="assets/meetings/yt2.png" width="40%">

1. Click on `Create` and select `Go live`:

<img src="assets/meetings/yt3.png" width="40%">

1. Once new live stream is created, in the list of `Upcomming` streams, click `View in Live Control Room` <img src="assets/meetings/yt5.png" width="3%"> icon next to your live stream:
1. Once a new live stream is created, in the list of `Upcoming` streams, click `View in Live Control Room` <img src="assets/meetings/yt5.png" width="3%"> icon next to your live stream:

<img src="assets/meetings/yt4.png" width="50%">

Expand All @@ -103,7 +103,7 @@ This is what you need to do to kick it off:

<img src="assets/meetings/restream1.png" width="50%">

1. After enabling audio, video and providing name, you will see a Restream Studio.
1. After enabling the audio, video and providing the name, you will see a Restream Studio.

1. `Edit` the title and description of the stream:

Expand All @@ -112,15 +112,15 @@ This is what you need to do to kick it off:
1. Provide title and description and click `Next`:

- 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.
- Meeting description must be provided even if the field is empty; otherwise, the old one from other streams will be used.

<img src="assets/meetings/restream5.png" width="50%">

1. `Edit` YouTube destination:

<img src="assets/meetings/restream6.png" width="40%">

1. Make sure you do not create new event but you select the one you already created on YouTube, with closed captions on:
1. Make sure you do not create a new event, but select the one you already created on YouTube, with closed captions on:

<img src="assets/meetings/restream7.png" width="40%">

Expand All @@ -140,7 +140,7 @@ Subscribe to the [AsyncAPI Newsletter](https://asyncapi.com/newsletter) to get i
We have an automated workflow in place:
1. Automation starts every Friday at midnight
1. It gets information from Google Calendar about all the meetings scheduled for the upcoming week
1. It schedules a MailChimp campaign to send emails with a list of meetings. It's sent on Friday at 11AM in the subscriber's time zone
1. It schedules a MailChimp campaign to send emails with a list of meetings. It's sent on Friday at 11 AM in the subscriber's time zone

### Where can I find the AsyncAPI calendar?

Expand All @@ -156,7 +156,7 @@ We have an automated workflow in place:
1. It checks if a closed issue represents a future event
1. It removes meetings from the AsyncAPI Google Calendar

### How do I register a new regular meeting?
### How do I register for a new regular meeting?

Start [discussion in community repository](https://github.com/asyncapi/community/discussions). Explain the idea and justify why it requires a separate meeting. We currently have [approval from the Technical Steering Commitee](https://github.com/asyncapi/community/discussions/295) to pay for up to 8 Zoom licenses.

Expand All @@ -165,4 +165,73 @@ Once a new meeting is approved, add a [new workflow like this one](.github/workf

### How can I become a host?

Once your `Regular` meeting gets approved, contact `Fran Mendez` so that he can give you access to all required tools.
Once your `Regular` meeting gets approved, contact `Fran Mendez` so he can give you access to all required tools.



## How do I publish broadcasted meetings as podcasts?

### Why do we need this feature?

- Some people prefer to listen to the video/livestream as an audio (podcast) instead of watching the video.

- 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.


### 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.

### What is needed?

- The YouTube video ID is needed to trigger the workflow.

### 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: ⬇️

#### 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`


### List of different types of YouTube links

- `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


### Step-by-step procedure

Here is an example with a procedure on how to use this workflow:

1. Go to the `Actions` section on GitHub.
2. Scroll down the menu on the left-hand side.
3. Click on the `Upload Episode from YouTube To Spotify for Podcasters` option.
4. Click on the `Run Workflow` button.
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!

You can also modify description and other information for 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.
3. Perform edits and save them.
5 changes: 5 additions & 0 deletions tweets/recurring-discuss-ideas/2023-11-01.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Do you have some nice ideas for #AsyncAPI-related tools? Do you want to validate and share with the AsyncAPI community?

Drop it 👇 and let us have an open discussion 🚀

https://github.com/asyncapi/community/discussions/categories/ideas
5 changes: 5 additions & 0 deletions tweets/recurring-discuss-ideas/2023-12-01.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Do you have some nice ideas for #AsyncAPI-related tools? Do you want to validate and share with the AsyncAPI community?

Drop it 👇 and let us have an open discussion 🚀

https://github.com/asyncapi/community/discussions/categories/ideas
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-10-07.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-10-14.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-10-21.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-10-28.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-11-04.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-11-11.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-11-18.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-11-25.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾
7 changes: 7 additions & 0 deletions tweets/recurring-slack-link/2023-12-02.tweet
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
✨ Did you know #AsyncAPI is on Slack? ✨

Join our Slack workspace to chat with anyone from our Open-Source community!

🔗 asyncapi.com/slack-invite

Ask for help and help others too. 💪🏿💪🏽🦾

0 comments on commit 0054c57

Please sign in to comment.