Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion markdown/docs/community/000-onboarding/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 2

The AsyncAPI technical writer onboarding guide teaches new community members how to contribute to our documentation effectively.

> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](https://github.com/asyncapi/community/blob/master/CONTRIBUTING.md).
> For a comprehensive understanding of the various ways you can contribute to the AsyncAPI Initiative, please consult the [AsyncAPI contributing guidelines](../../CONTRIBUTING.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

Verify CONTRIBUTING.md path; current relative link likely off by one directory.

From markdown/docs/community/000-onboarding/index.md, ../../CONTRIBUTING.md resolves to markdown/docs/CONTRIBUTING.md. If CONTRIBUTING.md is at repo root or elsewhere, this link will 404. Please confirm location and adjust (e.g., ../../../CONTRIBUTING.md or an absolute site path) accordingly.

Run to locate the correct path and preview all inbound links to CONTRIBUTING.md:


🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "Finding CONTRIBUTING files:"
fd -i 'contributing.md|CONTRIBUTING.md' -t f

echo
echo "Show current link usage in onboarding file:"
nl -ba markdown/docs/community/000-onboarding/index.md | sed -n '1,120p' | rg -n 'CONTRIBUTING\.md' -n -n -N

echo
echo "Check for a site-level Contributing page that might be preferable:"
rg -n -C2 -i 'contributing' --type md markdown | head -n 100

Length of output: 129


Fix CONTRIBUTING.md link (markdown/docs/community/000-onboarding/index.md:9)
../../CONTRIBUTING.md resolves to markdown/docs/CONTRIBUTING.md (404); update to link the root CONTRIBUTING.md, e.g. /CONTRIBUTING.md or the correct relative path (../../../../CONTRIBUTING.md).

🤖 Prompt for AI Agents
In markdown/docs/community/000-onboarding/index.md around line 9, the
CONTRIBUTING.md link currently uses ../../CONTRIBUTING.md which resolves to
markdown/docs/CONTRIBUTING.md (404); update the link to point to the repository
root CONTRIBUTING.md (use /CONTRIBUTING.md) or correct the relative path
(../../../../CONTRIBUTING.md) so the link resolves to the root CONTRIBUTING.md.


The goal is providing docs contributors with the necessary tools and knowledge to:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,35 +49,35 @@ This is what you need to do to kick it off:

1. Log into [Restream.io](https://app.restream.io/home) and select `Encoder|RMTP (Stream from OBS,Zoom,VMix,etc.)` option:

<img src="../../assets/meetings/stream1.png" width="50%" alt="Restream: Encoder | RTMP option selected"/>
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/stream1.png" width="50%" alt="Restream: Encoder | RTMP option selected"/>

1. Click `Update Titles` card:

<img src="../../assets/meetings/stream2.png" width="50%" alt="Restream: Update Titles card" />
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/stream2.png" width="50%" alt="Restream: Update Titles card" />

1. Provide title and description:

- Title for the live stream that corresponds to the meeting you just started.
- Provide a meeting description even if you plan to leave it brief; otherwise, the previous description from another stream might be reused.
- Add a thumbnail for the stream, as platforms like YouTube require one.

<img src="../../assets/meetings/stream3.png" width="50%" alt="Restream: Provide title, description, and thumbnail screen" />
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/stream3.png" width="50%" alt="Restream: Provide title, description, and thumbnail screen" />

1. In Zoom, click the `Live Transcript` button to start transcribing the meeting:

![Live Transcript](../../assets/meetings/zoom1.png)
![Live Transcript](https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/zoom1.png)

1. Confirm transcriptions with `Enable` button:

![Enable Transcript](../../assets/meetings/zoom2.png)
![Enable Transcript](https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/zoom2.png)

1. Click `More`:

![More Options](../../assets/meetings/zoom3.png)
![More Options](https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/zoom3.png)

1. Select `Live on Custom Live Stream Service` option to start streaming to Restream and, therefore, to official AsyncAPI social networks:

![Live on Custom Live Stream Service](../../assets/meetings/zoom4.png)
![Live on Custom Live Stream Service](https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/zoom4.png)

#### Restream-first

Expand All @@ -87,48 +87,48 @@ 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`:

<img src="../../assets/meetings/yt1.png" width="40%" alt="Switch account to AsyncAPI"/>
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/yt1.png" width="40%" alt="Switch account to AsyncAPI"/>

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%" alt="AsyncAPI option" />
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/yt2.png" width="40%" alt="AsyncAPI option" />

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

<img src="../../assets/meetings/yt3.png" width="40%" alt="Create and Go Live options"/>
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/yt3.png" width="40%" alt="Create and Go Live options"/>

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%" alt="Live icon" /> 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="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/yt5.png" width="3%" alt="Live icon" /> icon next to your live stream:

<img src="../../assets/meetings/yt4.png" width="50%" alt="View in Live Control Room"/>
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/yt4.png" width="50%" alt="View in Live Control Room"/>

1. Enable `Closed captions`:

<img src="../../assets/meetings/yt6.png" width="50%" alt="Enable closed captions button"/>
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/yt6.png" width="50%" alt="Enable closed captions button"/>

1. Log into [Restream.io](https://app.restream.io/home) and select `Start with Studio` option:

<img src="../../assets/meetings/restream1.png" width="50%" alt="Restream: Start with studio option" />
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/restream1.png" width="50%" alt="Restream: Start with studio option" />

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:

<img src="../../assets/meetings/restream4.png" width="50%" alt="Restream: edit title and description" />
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/restream4.png" width="50%" alt="Restream: edit title and description" />

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.

<img src="../../assets/meetings/restream5.png" width="50%" alt="Restream: Providing stream details"/>
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/restream5.png" width="50%" alt="Restream: Providing stream details"/>

1. `Edit` YouTube destination:

<img src="../../assets/meetings/restream6.png" width="40%" alt="Restream: YouTube destination" />
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/restream6.png" width="40%" alt="Restream: YouTube destination" />

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%" alt="Restream: Create event" />
<img src="https://raw.githubusercontent.com/asyncapi/community/master/assets/meetings/restream7.png" width="40%" alt="Restream: Create event" />

1. You are ready to `Go Live`

Expand Down
Loading