Skip to content

docs: reorganize documents in the community repo #1833

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
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
36 changes: 0 additions & 36 deletions .github/workflows/twitter-a-main-workflow.yml

This file was deleted.

2 changes: 1 addition & 1 deletion GOVERNANCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,4 @@ We no longer have Executive Directors in the project.
| Email | [email protected] |
| AsyncAPI Slack | Lukasz Gornicki (User ID: `UD698Q5LM`) |
| GitHub | https://github.com/derberg |
| Twitter | https://twitter.com/derberq |
| Twitter | https://twitter.com/derberq |
395 changes: 395 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

58 changes: 0 additions & 58 deletions TWEET_TOGETHER.md

This file was deleted.

File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Complete in order the following onboarding tasks:
- [ ] Read the [AsyncAPI Slack etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md).
- [ ] Join [the AsyncAPI Slack workspace](https://asyncapi.com/slack-invite).
- [ ] Add the AsyncAPI calendar found in [the AsyncAPI events page](https://www.asyncapi.com/community/events).
- [ ] Read the list of [technical writer contributor responsibilities](technical-writer-contributor-responsibilities).
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](prerequisite-knowledge).
- [ ] Read the list of [technical writer contributor responsibilities](../010-contribution-guidelines/technical-writer-contributor-responsibilities).
- [ ] Read and familiarize yourself with the [prerequisite knowledge topics](../010-contribution-guidelines/prerequisite-knowledge).
- [ ] Familiarize yourself with the _work-in-progress_ [AsyncAPI Style Guide](https://github.com/asyncapi/community/pulls?q=is%3Apr+is%3Aopen+style+guide).
- [ ] Read all docs under the following content buckets: `Concepts`, `Tutorials`, `Reference`. (Take the time to go through each tutorial.)
- [ ] Set up your local environment following our instructions for the [AsyncAPI git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md).
Expand Down
3 changes: 3 additions & 0 deletions docs/000-onboarding/documentarian-onboarding-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
🚧 This document is under construction.

Please be patient as we work on it. Thank you. 🫶
3 changes: 3 additions & 0 deletions docs/000-onboarding/how-to-contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
🚧 This document is under construction.

Please be patient as we work on it. Thank you. 🫶
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/000-onboarding/where-to-contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
🚧 This document is under construction.

Please be patient as we work on it. Thank you. 🫶
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ That's it! You've successfully submitted your first Pull Request.
- If needed, respond to their comments and make changes.
- Once approved, a maintainer will merge your PR into the official AsyncAPI repository!

Every contribution matters, no matter how small. Dive in and let’s build something amazing together!
Every contribution matters, no matter how small. Dive in and let’s build something amazing together!
Original file line number Diff line number Diff line change
Expand Up @@ -127,4 +127,3 @@ You can follow the steps from the [GitHub documentation](https://docs.github.com
```

4. Create a pull request from your branch of the fork repository to the `master` branch of the `upstream` repository and await review.

Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@ Keep these best practices in mind as you mentor and lead:

- [AsyncAPI Maintainer Guide](https://www.asyncapi.com/docs/community/onboarding-guide/maintainer-guide)
- [GSoC Mentor Guide](https://google.github.io/gsocguides/mentor/)
- [Open Source Best Practices](https://opensource.guide/best-practices/)
- [Open Source Best Practices](https://opensource.guide/best-practices/)
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ When writing documentation and other forms of content for AsyncAPI, use the pres
If you're looking for more information on grammar and style, consider checking out the following guides:

- [Google Style Guide](https://developers.google.com/style)
- [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
- [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/)
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,4 @@ Always indicate a general time zone (e.g., UTC). Use the 12-hour format where ap

#### Examples
- "11:00 AM (UTC)"
- "3:15 PM (UTC)"
- "3:15 PM (UTC)"
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ There are several ways to reach out to the TSC members:

> [!IMPORTANT]
> Please remember that the TSC members are volunteers and may not respond immediately.
> Please be patient and respectful. Also, it will be helpful if there is as little spam as possible. For more information, please refer to the [Slack Etiquette](./slack-etiquette.md) document.
> Please be patient and respectful. Also, it will be helpful if there is as little spam as possible. For more information, please refer to the [Slack Etiquette](../060-meetings-and-communication/slack-etiquette.md) document.


[code-owners]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ Working Groups should be listed on the [AsyncAPI website](https://www.asyncapi.c

There are several ways to reach out to a Working Group:

- Join the [AsyncAPI Slack](https://www.asyncapi.com/slack-invite) and ping the working group's handle to ask questions or share your thoughts. The handle can be found in the [WORKING_GROUPS.yaml](./WORKING_GROUPS.yaml) file in the `slack.group.handle` field. Example: `@dx_wg`.
- Do a GitHub team mention in any issue, discussion, or pull request. The team handle can be found in the [WORKING_GROUPS.yaml](./WORKING_GROUPS.yaml) file in `github_team` field. Example: `developer_experience_wg`.
- Join the working group's channel on Slack. The channel name can be found in the [WORKING_GROUPS.yaml](./WORKING_GROUPS.yaml) file in the `slack.channel.handle` field. Example: `#wg-developer-experience`.
- Join the [AsyncAPI Slack](https://www.asyncapi.com/slack-invite) and ping the working group's handle to ask questions or share your thoughts. The handle can be found in the [WORKING_GROUPS.yaml](../../WORKING_GROUPS.yaml) file in the `slack.group.handle` field. Example: `@dx_wg`.
- Do a GitHub team mention in any issue, discussion, or pull request. The team handle can be found in the [WORKING_GROUPS.yaml](../../WORKING_GROUPS.yaml) file in `github_team` field. Example: `developer_experience_wg`.
- Join the working group's channel on Slack. The channel name can be found in the [WORKING_GROUPS.yaml](../../WORKING_GROUPS.yaml) file in the `slack.channel.handle` field. Example: `#wg-developer-experience`.

> [!IMPORTANT]
> Please note that the Working Group members are volunteers and may not be able to respond immediately. Please be patient and respectful. Also, it will be helpful if there is as little spam as possible. For more information, please refer to the [Slack Etiquette](./slack-etiquette.md) document.
> Please note that the Working Group members are volunteers and may not be able to respond immediately. Please be patient and respectful. Also, it will be helpful if there is as little spam as possible. For more information, please refer to the [Slack Etiquette](../060-meetings-and-communication/slack-etiquette.md) document.
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/030-project-vision-strategy-goals/ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
🚧 This document is under construction.

Please be patient as we work on it. Thank you. 🫶
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -44,34 +44,34 @@ This is what you need to do to kick it off:

1. Log into [Restream.io](https://app.restream.io/home) and select `Set up for OBS, Zoom, etc.` option:

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

1. Click `Update Titles` card:

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

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.

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

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

![](assets/meetings/zoom1.png)
![](../../assets/meetings/zoom1.png)

1. Confirm transcriptions with `Enable` button:

![](assets/meetings/zoom2.png)
![](../../assets/meetings/zoom2.png)

1. Click `More`:

![](assets/meetings/zoom3.png)
![](../../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:

![](assets/meetings/zoom4.png)
![](../../assets/meetings/zoom4.png)

#### Restream-first

Expand All @@ -81,48 +81,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%">
<img src="../../assets/meetings/yt1.png" width="40%">

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%">
<img src="../../assets/meetings/yt2.png" width="40%">

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

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

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:
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%">
<img src="../../assets/meetings/yt4.png" width="50%">

1. Enable `Closed captions`:

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

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

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

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%">
<img src="../../assets/meetings/restream4.png" width="50%">

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%">
<img src="../../assets/meetings/restream5.png" width="50%">

1. `Edit` YouTube destination:

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

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%">
<img src="../../assets/meetings/restream7.png" width="40%">

1. You are ready to `Go Live`

Expand Down Expand Up @@ -160,7 +160,7 @@ We have an automated workflow in place:

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.

Once a new meeting is approved, add a [new workflow like this one](.github/workflows/create-event-community-meeting.yml) and a [new GitHub issue template like this one](.github/workflows/create-event-helpers/issues_templates/community.md).
Once a new meeting is approved, add a [new workflow like this one](../../.github/workflows/create-event-community-meeting.yml) and a [new GitHub issue template like this one](../../.github/workflows/create-event-helpers/issues_templates/community.md).


### How can I become a host?
Expand Down
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/070-marketing/social-media-communication-guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
🚧 This document is under construction.

Please be patient as we work on it. Thank you. 🫶
File renamed without changes.
Loading