Skip to content

Commit 4873db5

Browse files
RobotSailRobotSail
authored
update website to include references to discord (#28)
Signed-off-by: Oleg S <[email protected]>
1 parent a04079d commit 4873db5

8 files changed

+137
-6
lines changed

‎docs/community/CODE_OF_CONDUCT_COMMITTEE.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ We take reports of violations to our project [Code of Conduct](https://github.co
44

55
To report a Code of Conduct violation to our Code of Conduct Committee, you may reach out to us by email at [[email protected]](mailto:[email protected]). The email will be read and acted upon by our Code of Conduct Committee members.
66

7+
If you experience a Code of Conduct violation in our InstructLab Discord workspace, please follow the [instructions in our moderation guide](https://github.com/instructlab/community/blob/main/InstructLab_DISCORD_MODERATION_GUIDE.md#reporting-abuse) to get immediate help in Discord.
8+
79
If you experience a Code of Conduct violation in our InstructLab Slack workspace, please follow the [instructions in our moderation guide](https://github.com/instructlab/community/blob/main/InstructLab_SLACK_MODERATION_GUIDE.md#reporting-abuse) to get immediate help in Slack.
810

911
As part of our follow up on your report, we would like to contact you for further discussion. If you would prefer not to engage beyond reporting the matter to the committee, please let us know that as part of your submission. We will respect your request.

‎docs/community/FAQ.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ The goal on the InstructLab project is to emocratize contributions to AI and LLM
9494

9595
### How can I contribute?
9696

97-
You can begin your contribution journey by reading over the [Contributing](https://github.com/instruct-lab/community/blob/main/CONTRIBUTING.md) guide and joining the [Community Slack Channel](https://github.com/instructlab/community/blob/main/InstructLabSlackGuide.md).
97+
You can begin your contribution journey by reading over the [Contributing](https://github.com/instruct-lab/community/blob/main/CONTRIBUTING.md) guide and joining the [Community Discord Server](https://instructlab.ai/discord) or the [Community Slack Channel](https://github.com/instructlab/community/blob/main/InstructLabSlackGuide.md).
9898

9999
When you're ready to start contributing, you can follow the [Getting Started](https://github.com/instruct-lab/community/blob/main/README.md#getting-started-with-the-instructlab-project-workstreams) guide. This guide shows you how to
100100

@@ -230,7 +230,7 @@ The latest version of InstructLab can be downloaded using the `ilab download` CL
230230

231231
### I have a question about the project. Where should I go?
232232

233-
Currently, the best method for communicating with peers and project maintainers is in the Community Slack Channel. Visit our [InstructLab Slack Workspace Guide](https://github.com/instructlab/community/blob/main/InstructLabSlackGuide.md) for information on how to join.
233+
Currently, the best method for communicating with peers and project maintainers is in the Community Discord/Slack servers. Visit our [InstructLab Slack Workspace Guide](https://github.com/instructlab/community/blob/main/InstructLab_DISCORD_GUIDE.md), [InstructLab Slack Workspace Guide](https://github.com/instructlab/community/blob/main/InstructLab_SLACK_GUIDE.md) for information on how to join.
234234

235235
See our [community collaboration page](https://github.com/instructlab/community/blob/main/Collaboration.md), including information on our mailing list, meetings, and other ways of interacting with the community.
236236

@@ -284,14 +284,19 @@ To run and train InstructLab locally, you must meet the following requirements:
284284

285285
## Additional Resources
286286

287-
Additional resources, including the Code of Conduct, Code of Conduct Committee members, how to contribute, how to join the Slack channel, and more, can be found in the following repositories:
287+
Additional resources, including the Code of Conduct, Code of Conduct Committee members, how to contribute, how to join the Discord or Slack server, and more, can be found in the following repositories:
288288

289289
[InstructLab Taxonomy Repository](https://github.com/instructlab/taxonomy)
290290

291291
[InstructLab CLI Repository](https://github.com/instructlab/instructlab)
292292

293293
[InstructLab Community Repository](https://github.com/instructlab/community)
294294

295+
Discord and communication
296+
297+
- [Joining the Discord Server](https://github.com/instructlab/community/blob/main/InstructLab_DISCORD_GUIDE.md)
298+
- [Discord Moderation](https://github.com/instructlab/community/blob/main/InstructLab_DISCORD_MODERATION_GUIDE.md)
299+
295300
Slack and communication
296301

297302
- [Joining the Slack Channel](https://github.com/instructlab/community/blob/main/InstructLabSlackGuide.md)

‎docs/community/GOVERNANCE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The InstructLab Project has a two-level governance structure with an Oversight C
1515

1616
Except where otherwise noted, decisions should always start at the most local level of project governance. For example, decisions that affect only one project, such as the taxonomy repository and not the `ilab` CLI tool, can happen within the taxonomy project. While communication between the different project teams is important as they are all interconnected, minor decisions do not need organization-wide consensus and can be moved forward at the project level.
1717

18-
Changes in maintainership and other governance are currently announced on the InstructLab community Slack channel. Directions to join the Slack channel can be found [here](https://github.com/instructlab/community/blob/main/InstructLabSlackGuide.md). Changes are also announced to the [announce mailing list](https://github.com/instructlab/community/blob/main/Collaboration.md#email-lists).
18+
Changes in maintainership and other governance are currently announced on the InstructLab community Discord and Slack servers. Directions to join the Discord server can be found [here](https://github.com/instructlab/community/blob/main/InstructLab_DISCORD_GUIDE.md), and instructions for the Slack server can be found [here](https://github.com/instructlab/community/blob/main/InstructLab_SLACK_GUIDE.md). Changes are also announced to the [announce mailing list](https://github.com/instructlab/community/blob/main/Collaboration.md#email-lists).
1919

2020
## Project Maintainers overview
2121

‎docs/community/InstructLab_DISCORD_GUIDE.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# InstructLab Discord Server Guide
2+
3+
The purpose of this document is to inform members about how to join the
4+
[InstructLab Discord Server](https://instructlab.ai/discord) and outline the channels available. We look forward
5+
to meeting everyone and welcoming you to Discord!
6+
7+
## Overview
8+
9+
The InstructLab Discord server can be accessed via this [invitation link](https://instructlab.ai/discord).
10+
11+
Upon joining, you will automatically be assigned the `@Labs` role and gain access to the `#announcements` channel, as
12+
well as a number of the other default channels. You are welcome and encouraged to join other channels that may exist.
13+
14+
All discussions in the InstructLab Discord server are governed by our
15+
[project code of conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md).
16+
17+
## Opt-in Channels
18+
19+
To ensure that users are not overwhelmed by notifications, we have a few automated channels as opt-in only. In order to
20+
join them, visit the `#welcome-and-rules` channels and react with the emoji corresponding to the channel you wish to
21+
join.
22+
23+
Currently, these channels are:
24+
25+
- `#receive-e2e-logs`: Pushes updates about E2E runs that take place in our GitHub CI, allowing users to watch for failures.
26+
27+
## Moderation and Reporting Abuse
28+
29+
We are an open, welcoming, and inclusive community and expect our members to be kind and respectful in all discourse.
30+
31+
We take reports of harassment very seriously and will address any reports of inappropriate behavior as quickly as possible.
32+
33+
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).
34+
35+
## Having Trouble Joining?
36+
37+
If you are having trouble joining the InstructLab Discord server, please file an issue in the
38+
[community repo](https://github.com/instructlab/community/issues) so we can help you.
39+
40+
TODO: Update with email address to get help once these are set up.
41+
42+
## Private Channels
43+
44+
InstructLab is an open-source project and we value defaulting to open in all of our community communications.
45+
However, there are some cases where discussions must happen in private. For the sake of transparency, we are documenting
46+
these private channels and their purposes.
47+
48+
- `#code-of-conduct-committee` – Space for the InstructLab
49+
[Code of Conduct Committee](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT_COMMITTEE.md) to discuss
50+
any reports of harassment or other violations of the project Code of Conduct and how to respond to them.
51+
- `#admin` – Space for the InstructLab Server Administrators to confer privately only when
52+
necessary. We default to open channels and hold each other accountable to do so.

‎docs/community/InstructLab_DISCORD_MODERATION_GUIDE.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# InstructLab Discord Moderation Guide
2+
3+
The purpose of this document is to describe how users of the
4+
[InstructLab Discord server](https://instructlab.ai/discord) can report abuse within the Discord server and to provide
5+
server administrators with an easy-to-use guide for channel moderation.
6+
7+
## Reporting Abuse
8+
9+
Should any community members using the InstructLab Discord server feel that they have experienced behavior that violates
10+
our [project Code of Conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md), they are welcome
11+
and encouraged to contact the members of the
12+
[Code of Conduct Committee](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT_COMMITTEE.md) for help.
13+
Mentioning `@dog-watch` will notify all members of the moderation team so that they can assist you.
14+
15+
In the event that you do not receive help within a timely fashion – and we will do our very best to respond right away –
16+
you can ask for help from the server admins by either joining the `#ask-an-admin` channel or mentioning `@admins`. If
17+
you feel that it is a personal matter, you can also ping one of the people with the role of `#dog-watch` directly.
18+
19+
## Moderation Guide
20+
21+
Moderation activities can only be performed by users who are designated as server administrators (i.e. `@dog-watch`/
22+
`@lead-retriever`).
23+
24+
## Server Administrators
25+
26+
At the time of writing this, anyone with either the `@dog-watch` or `@lead-retriever` role is considered to be a
27+
moderator or administrator respectively.
28+
29+
\+ Members of the
30+
[Code of Conduct Committee](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT_COMMITTEE.md)
31+
32+
## How We Moderate
33+
34+
### Deleting Inappropriate Comments
35+
36+
Upon a report of abuse to the [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/COCC.md)
37+
or, alternatively, if needed to the server administrators due to a coverage gap, the appropriate parties will assess
38+
the situation.
39+
40+
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).
41+
42+
Inappropriate or offensive messages will be deleted. To delete a message, simply click on the three vertical dots that
43+
appear when you hover over a message, or on mobile simply tap and hold on a message, and then click the **Delete**
44+
button:
45+
46+
![Delete Message](https://raw.githubusercontent.com/instructlab/community/main/public/images/discord_delete_message.png)
47+
48+
Deleting a message shall be done at the sole discretion of the Code of Conduct Committee and/or server administrators.
49+
50+
### Removing Server Members
51+
52+
Admins should consider first removing the offending person's messages from the channel in which the unacceptable
53+
behavior occurred and having a conversation with them via Direct Message (DM) to remind them of their responsibilities
54+
to abide by the [project Code of Conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md) as
55+
part of their participation in the InstructLab community.
56+
57+
If a user is a repeat offender, after being warned, their account can be
58+
[kicked/banned](https://whop.com/blog/how-to-kick-someone-from-a-discord-server/) by an admin, depending on the
59+
situation.
60+
61+
For more details on moderating a Discord server, please refer to the following guides:
62+
63+
- [How to kick someone from a Discord server](https://whop.com/blog/how-to-kick-someone-from-a-discord-server/)
64+
- [Auto Moderation in Discord](https://discord.com/safety/auto-moderation-in-discord)
65+
66+
#### Banning a Member's Account
67+
68+
If you feel that a community member is violating the
69+
[InstructLab Code of Conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md), please reach out
70+
to the server moderators or the Code of Conduct Committee to receive further assistance.

‎docs/user-interface/env_oauth_config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,4 @@ Once the app is created, there will be an option to create a secret. Press the C
4848
Update the .env files with the new ID and secret ID generated, `OAUTH_GITHUB_ID` = Client ID, `OAUTH_GITHUB_SECRET` = Client Secret
4949

5050
!!! note
51-
If you prefer to not set up the OAuth, we recommend for you to reach out to the UI Maintainers in our `#ui` [slack channel](https://join.slack.com/t/instruct-lab/shared_invite/zt-2kieyqiz9-zhXSxGnXk6uL_f3hVbD53g) , where they will provide details for setting up an OAuth app for the instructlab-public org.
51+
If you prefer to not set up the OAuth, we recommend for you to reach out to the UI Maintainers in our `#ui` [discord server](https://instructlab.ai/discord) or [slack channel](https://join.slack.com/t/instruct-lab/shared_invite/zt-2kieyqiz9-zhXSxGnXk6uL_f3hVbD53g) , where they will provide details for setting up an OAuth app for the instructlab-public org.

‎docs/user-interface/ui_overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ There are 2 ways to access the UI:
2020
To log into the UI and submit Knowledge and Skills contributions, you must be a member of the [instructlab-public](https://github.com/instructlab-public) github repository.
2121

2222
!!! note
23-
If you aren't a member of the repository, but still wish to experiment with the UI, we recommend you to reach out to the UI Maintainers in our `#ui` [slack channel](https://join.slack.com/t/instruct-lab/shared_invite/zt-2kieyqiz9-zhXSxGnXk6uL_f3hVbD53g) for an invitation.
23+
If you aren't a member of the repository, but still wish to experiment with the UI, we recommend you to reach out to the UI Maintainers in our `#ui` [Discord server](https://instructlab.ai/discord) or [slack channel](https://join.slack.com/t/instruct-lab/shared_invite/zt-2kieyqiz9-zhXSxGnXk6uL_f3hVbD53g) for an invitation.
2424

2525
If you wish to not join but still wish to experiment, download it locally.
2626

‎mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ nav:
2525
- Code of Conduct Committee: community/CODE_OF_CONDUCT_COMMITTEE.md
2626
- FAQ: community/FAQ.md
2727
- Governance Policy: community/GOVERNANCE.md
28+
- Discord Guide: community/InstructLab_DISCORD_GUIDE.md
29+
- Discord Moderation Guide: community/InstructLab_DISCORD_MODERATION_GUIDE.md
2830
- Slack Guide: community/InstructLab_SLACK_GUIDE.md
2931
- Slack Moderation Guide: community/InstructLab_SLACK_MODERATION_GUIDE.md
3032
- Taxonomy:

0 commit comments

Comments
 (0)