Skip to content

Commit

Permalink
add guides for the InstructLab Discord server
Browse files Browse the repository at this point in the history
Signed-off-by: Oleg S <97077423+RobotSail@users.noreply.github.com>
  • Loading branch information
RobotSail committed Dec 16, 2024
1 parent d09ec79 commit deb533b
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 0 deletions.
41 changes: 41 additions & 0 deletions InstructLab_DISCORD_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# InstructLab Discord Server Guide

The purpose of this document is to inform members about how to join the [InstructLab Discord Server](https://instructlab.ai/discord) and outline the channels available. We look forward to meeting everyone and welcoming you to Discord!

Check failure on line 3 in InstructLab_DISCORD_GUIDE.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

InstructLab_DISCORD_GUIDE.md:3:121 MD013/line-length Line length [Expected: 120; Actual: 234] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

## Overview

The InstructLab Discord server can be accessed via this [invitation link](https://instructlab.ai/discord).

Upon joining, you will automatically be assigned the `@Labs` role and gain access to the `#announcements` channel, as well as a number of the other default channels. You are welcome and encouraged to join other channels that may exist.

Check failure on line 9 in InstructLab_DISCORD_GUIDE.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

InstructLab_DISCORD_GUIDE.md:9:121 MD013/line-length Line length [Expected: 120; Actual: 235] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

All discussions in the InstructLab Discord server are governed by our [project code of conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md).

## Opt-in Channels

To ensure that users are not overwhelmed by notifications, we have a few automated channels as opt-in only. In order to join them, visit the `#welcome-and-rules` channels and react with the emoji corresponding to the channel you wish to join.

Check failure on line 15 in InstructLab_DISCORD_GUIDE.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

InstructLab_DISCORD_GUIDE.md:15:121 MD013/line-length Line length [Expected: 120; Actual: 242] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

Currently, these channels are:

- `#receive-e2e-logs`: Pushes updates about E2E runs that take place in our GitHub CI, allowing users to watch for failures.

## Moderation and Reporting Abuse

We are an open, welcoming, and inclusive community and expect our members to be kind and respectful in all discourse.

We take reports of harassment very seriously and will address any reports of inappropriate behavior as quickly as possible.

To learn how to report abuse – and to whom you will be reporting – please see our [InstructLab Discord Moderation Guide](https://github.com/instructlab/community/blob/main/InstructLabDiscordModerationGuide.md).

## Having Trouble Joining?

If you are having trouble joining the InstructLab Discord server, please file an issue in the [community repo](https://github.com/instructlab/community/issues) so we can help you.

Check failure on line 31 in InstructLab_DISCORD_GUIDE.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

InstructLab_DISCORD_GUIDE.md:31:121 MD013/line-length Line length [Expected: 120; Actual: 179] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

TODO: Update with email address to get help once these are set up.

## Private Channels

InstructLab is an open-source project and we value defaulting to open in all of our community communications. However, there are some cases where discussions must happen in private. For the sake of transparency, we are documenting these private channels and their purposes.

Check failure on line 37 in InstructLab_DISCORD_GUIDE.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

InstructLab_DISCORD_GUIDE.md:37:121 MD013/line-length Line length [Expected: 120; Actual: 273] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

- `#code-of-conduct-committee` – Space for the InstructLab [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT_COMMITTEE.md) to discuss any reports of harassment or other violations of the project Code of Conduct and how to respond to them.

Check failure on line 39 in InstructLab_DISCORD_GUIDE.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

InstructLab_DISCORD_GUIDE.md:39:121 MD013/line-length Line length [Expected: 120; Actual: 283] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
- `#admin` – Space for the InstructLab [Server Administrators](#placeholder-for-role-link) to confer privately only when necessary. We default to open channels and hold each other accountable to do so.

Check failure on line 40 in InstructLab_DISCORD_GUIDE.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

InstructLab_DISCORD_GUIDE.md:40:121 MD013/line-length Line length [Expected: 120; Actual: 201] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

Check failure on line 40 in InstructLab_DISCORD_GUIDE.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Link fragments should be valid

InstructLab_DISCORD_GUIDE.md:40:40 MD051/link-fragments Link fragments should be valid [Context: "[Server Administrators](#placeholder-for-role-link)"] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md051.md

53 changes: 53 additions & 0 deletions InstructLab_DISCORD_MODERATION_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# InstructLab Discord Moderation Guide

The purpose of this document is to describe how users of the [InstructLab Discord server](https://instructlab.ai/discord) can report abuse within the Discord server and to provide server administrators with an easy-to-use guide for channel moderation.

Check failure on line 3 in InstructLab_DISCORD_MODERATION_GUIDE.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Line length

InstructLab_DISCORD_MODERATION_GUIDE.md:3:121 MD013/line-length Line length [Expected: 120; Actual: 251] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md

## Reporting Abuse

Should any community members using the InstructLab Discord server feel that they have experienced behavior that violates our [project Code of Conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md), they are welcome and encouraged to contact the members of the [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT_COMMITTEE.md) for help. Mentioning `@dog-watch` will notify all members of the moderation team so that they can assist you.

In the event that you do not receive help within a timely fashion – and we will do our very best to respond right away – you can ask for help from the server admins by either joining the `#ask-an-admin` channel or mentioning `@admins`. If you feel that it is a personal matter, you can also ping one of the people with the role of `#dog-watch` directly.

## Moderation Guide

Moderation activities can only be performed by users who are designated as server administrators (i.e. `@dog-watch`/`@lead-retriever`).

## Server Administrators

At the time of writing this, anyone with either the `@dog-watch` or `@lead-retriever` role is considered to be a moderator or administrator respectively.


\+ Members of the [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT_COMMITTEE.md)

## How We Moderate

### Deleting Inappropriate Comments

Upon a report of abuse to the [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/COCC.md) or, alternatively, if needed to the server administrators due to a coverage gap, the appropriate parties will assess the situation.

The first step will be to remind individuals to abide by the [project Code of Conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md).

Inappropriate or offensive messages will be deleted. To delete a message, simply click on the three vertical dots that appear when you hover over a message, or on mobile simply tap and hold on a message, and then click the **Delete** button:

![Delete Message](https://raw.githubusercontent.com/instructlab/community/main/public/images/discord_delete_message.png)


Deleting a message shall be done at the sole discretion of the Code of Conduct Committee and/or server administrators.

### Removing Server Members

Admins should consider first removing the offending person's messages from the channel in which the unacceptable behavior occurred and having a conversation with them via Direct Message (DM) to remind them of their responsibilities to abide by the [project Code of Conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md) as part of their participation in the InstructLab community.

If a user is a repeat offender, after being warned, their account can be [kicked/banned](https://whop.com/blog/how-to-kick-someone-from-a-discord-server/) by an admin, depending on the situation.

For more details on moderating a Discord server, please refer to the following guides:
- [How to kick someone from a Discord server](https://whop.com/blog/how-to-kick-someone-from-a-discord-server/)
- [Auto Moderation in Discord](https://discord.com/safety/auto-moderation-in-discord)


#### Banning a Member's Account

If you feel that a community member is violating the [InstructLab Code of Conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md), please reach out to the server moderators or the Code of Conduct Committee to receive further assistance.


[committee]: https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT_COMMITTEE.md
Binary file added public/images/discord_delete_message.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit deb533b

Please sign in to comment.