Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Shurtu-gal committed May 7, 2024
1 parent 246bb15 commit 69b71ac
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 6 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/slack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Three main resources are created using the slack integration:
- Use of bot token of the format `xoxo-<your-slack-token>` is not supported for creating user groups.
- The user group should be unique across the workspace (i.e., no channel, user, or user group should have the same handle).
- Please [import](#L52) the user groups to terraform state if they already exist in the workspace, as they **cannot be deleted** in Slack 😢.
- Please [import](#importing-existing-resources) the user groups to terraform state if they already exist in the workspace, as they **cannot be deleted** in Slack 😢.
> [!IMPORTANT]
> The terraform state will overwrite any description, name, or topic change. It is better to manage the changes in the YAML files and then apply them. However, the terraform state will not affect bookmarks, pinned items, etc.
Expand Down Expand Up @@ -118,19 +118,19 @@ main();
The groups can be mentioned in the slack messages using the `@<group-name>` syntax. Addition of groups can be done by adding the group to the [groups.yaml](./groups/groups.yaml) file.
The following groups are being created currently:
- [tsc](./groups/groups.yaml#L13)
- `tsc`
This group is for the Technical Steering Committee members mentioned in the [TSC_MEMBERS](../../../TSC_MEMBERS.json) file. Can be used to mention all the TSC members at once.
- [maintainers](./groups/groups.yaml#L19)
- `maintainers`
This group is for the all maintainers of the repository mentioned in the [MAINTAINERS](../../../MAINTAINERS.yaml) file. Can be used to mention all the maintainers at once.
- [studio](./groups/groups.yaml#L24)
- `studio`
This group consists of members actively working on the studio project.
- [coc_commitee](./groups/groups.yaml#L42)
- `coc_commitee`
This group consists of members of the Code of Conduct committee.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/slack/groups/groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

- name: "Studio"
handle: "studio"
description: "To notify all regular Studio contributors at once. If you don't contribute regularly but want to get notified too, ping Fran to get added."
description: "To notify all regular Studio contributors at once. If you don't contribute regularly but want to get notified too, please open a PR to get added."
users:
- "U01RWDD69PZ"
- "U0572R8J927"
Expand Down
9 changes: 9 additions & 0 deletions TSC_MEMBERSHIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,12 @@ Joining the TSC is something that you are allowed to do as a maintainer by defau

See current [TSC members](https://www.asyncapi.com/community/tsc).

## How to reach out to the TSC

There are several ways to reach out to the TSC members:

* Join the [AsyncAPI Slack](https://www.asyncapi.com/slack-invite) and ping the `@tsc` group to ask questions or share your thoughts.
* Do a GitHub team mention `@asyncapi/tsc_members` in any issue, discussion or pull request. This will also send a message in the `95_bot-tsc-members-mentioned` channel in the Slack.

> [!IMPORTANT]
> Please note that the TSC 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 less spam as possible. For more information, please refer to the [Slack Etiquette](./slack-etiquette.md) document.
11 changes: 11 additions & 0 deletions WORKING_GROUPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,14 @@ A Working Group must discuss ideas and solutions in public, and communicate thro
It is recommended that the Working Group schedules meetings using the methods described at https://github.com/asyncapi/community/blob/master/MEETINGS_ORGANIZATION.md.

Working Groups should be listed on the [AsyncAPI website](https://www.asyncapi.com), along with their description, goals, members, and anything the Working Group wants to include.

### How to reach out to a Working Group

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

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

0 comments on commit 69b71ac

Please sign in to comment.