Skip to content

Commit b8a9adf

Browse files
committed
Adds Slack info to various docs
Signed-off-by: Steven <[email protected]>
1 parent 1ad4396 commit b8a9adf

File tree

5 files changed

+21
-18
lines changed

5 files changed

+21
-18
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Participating in the InstructLab project can come by contributing to any one of
2727

2828
Help on open source projects is always welcome and there is always something that can be improved. For example, documentation (like the text you are reading now) can always use improvement, code can always be clarified, variables or functions can always be renamed or commented on, and there is always a need for more test coverage. If you see something that you think should be fixed, take ownership!
2929

30-
To contribute code or documentation, please submit a pull request to the relevant repository. Note that contribution to any repository has its own set of requirements and expectations, and users should familiar themselves with those expectations before contributing.
30+
To contribute code or documentation, please submit a pull request to the relevant repository. Note that contribution to any repository has its own set of requirements and expectations, and users should familiarize themselves with those expectations before contributing.
3131

3232
### ilab command-line interface (CLI) tool repository
3333

InstructLabSlackModerationGuide.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ abuse in the Slack workspace and to provide space administrators with an easy to
55

66
# Reporting Abuse
77

8-
Should any community members using the InstructLab Slack workspace 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/COCC.md) for help. Mentioning <code>@cocc</code> will page all members of the committee so that they can assist you.
8+
Should any community members using the InstructLab Slack workspace feel that they have experienced behavior that violates our [project Code of Conduct](https://github.com/instruct-lab/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/instruct-lab/community/blob/main/COCC.md) for help. Mentioning <code>@cocc</code> will page all members of the committee so that they can assist you.
99

1010
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 workspace admins by either joining channel <code>#admin</code> or mentioning <code>@admins</code>.
1111

1212
# Moderation Guide
1313

14-
Moderation activities can only be performed by users who are designated as workspace adminstrators.
14+
Moderation activities can only be performed by users who are designated as workspace administrators.
1515

1616
## Workspace Administrators
1717

@@ -41,9 +41,9 @@ At time of writing, our workspace adminstrators/moderators are as follows:
4141
## How We Moderate
4242

4343
## Deleting Inappropriate Comments
44-
Upon report of abuse to the [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/COCC.md) or, alternatively if needed to the workspace adminstrators due to a coverage gap, the appropriate parties will assess the situation.
44+
Upon report of abuse to the [Code of Conduct Committee](https://github.com/instruct-lab/community/blob/main/COCC.md) or, alternatively if needed to the workspace administrators due to a coverage gap, the appropriate parties will assess the situation.
4545

46-
The first step will be to remind folks to abide by the [project code of conduct](https://github.com/instructlab/community/blob/main/CODE_OF_CONDUCT.md).
46+
The first step will be to remind folks to abide by the [project Code of Conduct](https://github.com/instruct-lab/community/blob/main/CODE_OF_CONDUCT.md).
4747

4848
Inappropriate or offensive messages [will be deleted](https://slack.com/help/articles/202395258-Edit-or-delete-messages#delete-a-message).
4949

README.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ The following documentation shows you an overview of the workflow, and the resou
2929

3030
The `ilab` tool allows you to interact with the IBM AI model `Merlinite`, contribute your own information, and train the model locally.
3131

32-
> **Note:** Before proceeding, it might be beneficial to check out the [Contributing](https://github.com/instructlab/community/blob/main/CONTRIBUTING.md) guide for an overview of contributing practices and expectations.
32+
> **Note:** Before proceeding, it might be beneficial to check out the [Contributing](https://github.com/instruct-lab/community/blob/main/CONTRIBUTING.md) guide for an overview of contributing practices and expectations. Additionally, you should consider joining the [InstructLab community Slack channel](https://github.com/instructlab/community/blob/main/InstructLabSlackGuide.md).
3333
3434
1. Navigate to the `ilab` CLI repository and follow the instructions in the [README.md](https://github.com/instructlab/cli/blob/main/README.md). The README.md instructs you on how to perform the following:
3535

3636
a. In the [Getting started](https://github.com/instructlab/cli/blob/main/README.md#-getting-started) section of the README.md file, you can install the `ilab` tool, set up your local environment, and download the IBM `Merlinite` AI model.
3737

38-
b. You can then create your own data sets to feed into and train the model. In the taxonomy project, there are two types of data you can serve to the model: skills and knowledge. There are a few different types of skills and knowledge you can create. For more detailed information on the types, see the Taxonomy [README.md](https://github.com/instructlab/taxonomy/blob/main/README.md#getting-started-with-skill-contributions).
38+
b. You can then create your own data sets to feed into and train the model. In the taxonomy project, there are two types of data you can serve to the model: skills and knowledge. There are a few different types of skills and knowledge you can create. For more detailed information on the types, see the Taxonomy [README.md](https://github.com/instructlab/taxonomy/blob/main/README.md#welcome-to-the-instructlab-taxonomy).
3939

40-
c. In your local taxonomy repository, generated after the [Initialize lab](https://github.com/instructlab/cli/blob/main/README.md#%EF%B8%8F-initialize-lab) step, navigate to the path that you want to add information to. You can see a flow chart of the paths in this file [taxonomy_diagram](https://github.com/instructlab/taxonomy/blob/main/docs/taxonomy_diagram.png). Create a `qna.yaml` file in that path with your contributions.
40+
c. In your local taxonomy repository, generated after the [Initialize lab](https://github.com/instructlab/instructlab/blob/main/README.md#-installing-ilab) step, navigate to the path that you want to add information to. You can see a flow chart of the paths in this file [taxonomy_diagram](https://github.com/instruct-lab/taxonomy/blob/main/docs/taxonomy_diagram.png). Create a `qna.yaml` file in that path with your contributions.
4141

4242
d. [Serve and train the model](https://github.com/instructlab/cli/blob/main/README.md#-train-the-model) with your contributions to see if the model can answer questions more accurately.
4343

@@ -106,14 +106,17 @@ SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)
106106

107107
If you would like to see the detailed LICENSE click [here](LICENSE).
108108

109-
## Information resources
109+
## Contact resources
110110

111-
- [InstructLab Slack]() FORTHCOMING
111+
- [InstructLab Slack](https://instruct-lab.slack.com). See the InstuctLab Slack Guide for directions on how to join.
112+
- [InstructLab Slack Guide](https://github.com/instruct-lab/community/blob/main/InstructLabSlackGuide.md)
113+
- [InstructLab Slack Moderation Guide](https://github.com/instruct-lab/community/blob/main/InstructLabSlackModerationGuide.md)
112114
- [InstructLab Mailing lists]() FORTHCOMING
113-
- In the meantime, feel free to start a [discussion](https://github.com/orgs/instructlab/discussions).
115+
- [Discussion](https://github.com/orgs/instruct-lab/discussions).
114116

115117
## Quick Links
116118

119+
# [FAQ](FAQ.md)
117120
* [LICENSE](LICENSE)
118121
* [README](README.md)
119122
* [CONTRIBUTING](CONTRIBUTING.md)

docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,5 @@ We received so many at the beginning, and with jokes being "in the eye of the be
6161

6262
## Works Cited on this Page
6363
* [Christianity in Nepal](https://en.wikipedia.org/wiki/Christianity_in_Nepal), Wikipedia, Wikimedia Foundation, 24 April 2024.
64-
* [Concepts of Biology - 1st Canadian Edition](https://opentextbc.ca/biology/), Chapter 11.3 _Circulatory and Respiratory Systems_. Copyright 2015 by Charles Molnar and Jane Gair, licensed under a [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/). No modications were made to the text.
65-
* [World History, volume 2: from 1400](https://openstax.org/details/books/world-history-volume-2), Chapter 6.3 _Capitalism and the First Industrial Revolution_. Copyright 2022 Rice University, licensed under a [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/). No modications were made to the text.
64+
* [Concepts of Biology - 1st Canadian Edition](https://opentextbc.ca/biology/), Chapter 11.3 _Circulatory and Respiratory Systems_. Copyright 2015 by Charles Molnar and Jane Gair, licensed under a [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/). No modifications were made to the text.
65+
* [World History, volume 2: from 1400](https://openstax.org/details/books/world-history-volume-2), Chapter 6.3 _Capitalism and the First Industrial Revolution_. Copyright 2022 Rice University, licensed under a [Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/). No modifications were made to the text.

governance.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ At launch, the InstructLab Project will not have an Oversight Committee to avoid
1717

1818
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 that 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.
1919

20-
Changes in maintainership and other governance are announced on the **TODO: InstructLab mailing list**.
20+
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). In the future, a mailing list will be established.
2121

2222
## Project Maintainers overview
2323

@@ -66,7 +66,7 @@ The election will proceed according to the following process:
6666

6767
1. The nomination period will be three weeks. This period starts from the day after an organization Maintainer opening becomes available.
6868

69-
1. The nomination must be made by the **TODO: InstructLab mailing list**.
69+
1. The nomination must be made 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). In the future, a mailing list will be established for nominations.
7070

7171
1. After a nominated individual(s) agrees to be a candidate for the Oversight Committee, project Maintainers will vote. The voting period will be open for a minimum of three business days. It will remain open until a [supermajority](https://en.wikipedia.org/wiki/Supermajority#Two-thirds_vote) of project Maintainers has voted. Only current Maintainers of active projects are eligible to vote.
7272

@@ -78,7 +78,7 @@ The election will proceed according to the following process:
7878

7979
Project Maintainers or Oversight Committee members may resign or could be expelled as follows:
8080

81-
* Maintainers or an Oversight Committee member may step down through email. Within 7 calendar days, organization contributors and Maintainers will be notified of the change through an email from **TODO: InstructLab mailing list**.
81+
* Maintainers or an Oversight Committee member may step down through email. Within 7 calendar days, organization contributors and Maintainers will be notified 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). In the future, a mailing list will be established.
8282

8383
* After an Oversight Committee member steps down, they become an emeritus Maintainer.
8484

@@ -105,7 +105,7 @@ The secondary decision making process is done by voting. The following items mus
105105
* Licensing and intellectual property changes such as new logos or wordmarks (simple majority)
106106
* Adding, archiving, or removing projects (simple majority)
107107

108-
Other decisions may, but do not need to be, called out and put up for decision on the **TODO: InstructLab mailing list**. This can be done by anyone at any time. By default, any decisions called to a vote will be for a _simple majority_ vote.
108+
Other decisions may, but do not need to be, called out and put up for decision 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). In the future, a mailing list will be established. This can be done by anyone at any time. By default, any decisions called to a vote will be for a _simple majority_ vote.
109109

110110
## Code of Conduct
111111

@@ -115,7 +115,7 @@ The CoCC is responsible for investigating, evaluating, and recommending remedies
115115

116116
Current CoCC members can be found on the [Code of Conduct Committee](https://github.com/instructlab/community/blob/main/COCC.md) page.
117117

118-
Possible Code of Conduct violations should be reported to the Code of Conduct Committee at **TODO: Private CoC mailing list**.
118+
Possible Code of Conduct violations should be reported to the Code of Conduct Committee 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). In the future, a mailing list will be established.
119119

120120
## Developer Certificate of Origin (DCO) and Licenses
121121

0 commit comments

Comments
 (0)