Skip to content
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

docs: change references slack #5101

Merged
merged 19 commits into from
Jun 26, 2024
Merged
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
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 🗯 Community Discussions
url: https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g
about: Our Slack Community loves to discuss Argilla and NLP topics
url: http://hf.co/join/discord
about: Our Discord Community loves to discuss Argilla and NLP topics
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ However you choose to contribute, please be mindful and respect our

## Need some help?

We understand that getting started might be scary and difficult, therefore, we provide a guided contributor mentorship program. Feel free to schedule a meeting [here](https://calendly.com/david-berenstein-huggingface/30min) to get you started. Alternatively, you can start with [joining our Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g) and reaching out in our [contributor channel](https://rubrixworkspace.slack.com/archives/C05BCGM277B).
We understand that getting started might be a bit difficult, therefore, you can join our discord channel [#argilla-general](https://discord.gg/hugging-face-879548962464493619) by selecting *Argilla* in *Channels and Roles* after joining the Discord.

## Want to work on your own?

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
<a href="https://www.linkedin.com/company/argilla-io">
<img src="https://img.shields.io/badge/linkedin-blue?logo=linkedin"/>
</a>
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
<img src="https://img.shields.io/badge/slack-purple?logo=slack"/>
<a href="http://hf.co/join/discord">
<img src="https://img.shields.io/badge/Discord-7289DA?&logo=discord&logoColor=white"/>
</a>
</p>

Expand Down Expand Up @@ -61,7 +61,7 @@ We are an open-source community-driven project and we love to hear from you. Her

- [Community Meetup](https://lu.ma/embed-checkout/evt-IQtRiSuXZCIW6FB): listen in or present during one of our bi-weekly events.

- [Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g): get direct support from the community.
- [Discord](http://hf.co/join/discord): get direct support from the community in #argilla-general and #argilla-help.

- [Roadmap](https://github.com/orgs/argilla-io/projects/10/views/1): plans change but we love to discuss those with our community so feel encouraged to participate.

Expand Down
4 changes: 2 additions & 2 deletions argilla-frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
<a href="https://www.linkedin.com/company/argilla-io">
<img src="https://img.shields.io/badge/linkedin-blue?logo=linkedin"/>
</a>
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
<img src="https://img.shields.io/badge/slack-purple?logo=slack"/>
<a href="http://hf.co/join/discord">
<img src="https://img.shields.io/badge/Discord-7289DA?&logo=discord&logoColor=white"/>
</a>
</p>

Expand Down
4 changes: 2 additions & 2 deletions argilla-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
<a href="https://www.linkedin.com/company/argilla-io">
<img src="https://img.shields.io/badge/linkedin-blue?logo=linkedin"/>
</a>
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
<img src="https://img.shields.io/badge/slack-purple?logo=slack"/>
<a href="http://hf.co/join/discord">
<img src="https://img.shields.io/badge/Discord-7289DA?&logo=discord&logoColor=white"/>
</a>
</p>

Expand Down
5 changes: 2 additions & 3 deletions argilla-server/docker/quickstart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@


<p align="center">
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
<img src="https://img.shields.io/badge/JOIN US ON SLACK-4A154B?style=for-the-badge&logo=slack&logoColor=white" />
<a href="http://hf.co/join/discord">
<img src="https://img.shields.io/badge/JOIN US ON DISCORD-7289DA?style=for-the-badge&logo=discord&logoColor=white" />
</a>
<a href="https://linkedin.com/company/argilla-io">
<img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" />
Expand All @@ -46,7 +46,6 @@
<img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" />
</a>
</p>

<br>

<h3>
Expand Down
6 changes: 3 additions & 3 deletions argilla-v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
<a href="https://www.linkedin.com/company/argilla-io">
<img src="https://img.shields.io/badge/linkedin-blue?logo=linkedin"/>
</a>
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
<img src="https://img.shields.io/badge/slack-purple?logo=slack"/>
<a href="http://hf.co/join/discord">
<img src="https://img.shields.io/badge/Discord-7289DA?&logo=discord&logoColor=white"/>
</a>
</p>

Expand Down Expand Up @@ -61,7 +61,7 @@ We are an open-source community-driven project and we love to hear from you. Her

- [Community Meetup](https://lu.ma/embed-checkout/evt-IQtRiSuXZCIW6FB): listen in or present during one of our bi-weekly events.

- [Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g): get direct support from the community.
- [Discord](http://hf.co/join/discord"): get direct support from the community in #argilla-general and #argilla-help.

- [Roadmap](https://github.com/orgs/argilla-io/projects/10/views/1): plans change but we love to discuss those with our community so feel encouraged to participate.

Expand Down
6 changes: 3 additions & 3 deletions argilla/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@
<a href="https://www.linkedin.com/company/argilla-io">
<img src="https://img.shields.io/badge/linkedin-blue?logo=linkedin"/>
</a>
<a href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">
<img src="https://img.shields.io/badge/slack-purple?logo=slack"/>
<a href="http://hf.co/join/discord">
<img src="https://img.shields.io/badge/Discord-7289DA?&logo=discord&logoColor=white"/>
</a>
</p>

Expand Down Expand Up @@ -58,7 +58,7 @@ We are an open-source community-driven project and we love to hear from you. Her

- [Community Meetup](https://lu.ma/embed-checkout/evt-IQtRiSuXZCIW6FB): listen in or present during one of our bi-weekly events.

- [Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g): get direct support from the community.
- [Discord](http://hf.co/join/discord): get direct support from the community in #argilla-general and #argilla-help.

- [Roadmap](https://github.com/orgs/argilla-io/projects/10/views/1): plans change but we love to discuss those with our community so feel encouraged to participate.

Expand Down
41 changes: 12 additions & 29 deletions argilla/docs/community/contributor.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,32 +9,22 @@ Thank you for investing your time in contributing to the project! Any contributi
??? Question "New to contributing in general?"
If you're a new contributor, read the [README](https://github.com/argilla-io/argilla/blob/develop/README.md) to get an overview of the project. In addition, here are some resources to help you get started with open-source contributions:

* **Slack**: You are welcome to join the [Argilla Slack community](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g), where you can keep in touch with other users, contributors and the Argilla team. In the following [section](#first-contact-in-slack), you can find more information on how to get started in Slack.
* **Discord**: You are welcome to join the [Argilla Discord community](http://hf.co/join/discord), where you can keep in touch with other users, contributors and the Argilla team. In the following [section](#first-contact-in-discord), you can find more information on how to get started in Discord.
* **Git**: This is a very useful tool to keep track of the changes in your files. Using the command-line interface (CLI), you can make your contributions easily. For that, you need to have it [installed and updated](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) on your computer.
* **GitHub**: It is a platform and cloud-based service that uses git and allows developers to collaborate on projects. To contribute to Argilla, you'll need to create an account. Check the [Contributor Workflow with Git and Github](#contributor-workflow-with-git-and-github) for more info.
* **Developer Documentation**: To collaborate, you'll need to set up an efficient environment. Check the [developer documentation](../getting_started/installation.md) to know how to do it.
* **Schedule a meeting with our developer advocate**: If you have more questions, do not hesitate to contact our developer advocate and [schedule a meeting](https://calendly.com/david-berenstein-huggingface/30min).

## First Contact in Slack
## First Contact in Discord

Slack is a very useful tool for more casual conversations and to answer day-to-day questions. Click [here](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g) to join our Slack community effortlessly.
Discord is a handy tool for more casual conversations and to answer day-to-day questions. As part of Hugging Face, we have set up some Argilla channels on the server. Click [here](http://hf.co/join/discord) to join the Hugging Face Discord community effortlessly.

The following screens will be displayed, choose how you wish to join and enter the code sent to you via email.
When part of the Hugging Face Discord, you can select "Channels & roles" and select "Argilla" along with any of the other groups that are interesting to you. "Argilla" will cover anything about argilla and distilabel. You can join the following channels:

![argilla-slack](../assets/images/community/contributing/argilla-slack.png)
* **#argilla-general**: 📣 Stay up-to-date and general discussions.
* **#argilla-help**: 🙋‍♀️ Need assistance? We're always here to help. Select the appropriate label (argilla or distilabel) for your issue and post it.

Once you have joined the community, you'll be added to some channels by default, but below we show you all the community channels you can join:

* **00-announcements**: 📣 Stay up-to-date on official Argilla
* **01-introductions**: 👋 Say hi! to the community Fun facts are appreciated.
* **02-support-and-questions**: 🙋‍♀️ Need help with Argilla or NLP? We are always here.
* **03-discoveries-and-news**: 📚 Looking for resources and news related to everything NLP?
* **04-contributors**: 🏗️ A channel for contributions and contributors.
* **05-beta-testing**: 🚧 For access to the latest features and help us with testing the newest features.
* **06-general**: 🐒 This channel is for... well, everything else.
* **07-distilabel**: ⚗️ For all of you questions about our Distilabel project.

So now there is only one thing left to do, introduce yourself and talk to the community. You'll be always welcome! 🤗👋
So now there is only one thing left to do: introduce yourself and talk to the community. You'll always be welcome! 🤗👋


## Contributor Workflow with Git and GitHub
Expand Down Expand Up @@ -113,6 +103,7 @@ git checkout [branch-name]
### Use CHANGELOG.md

If you are working on a new feature, it is a good practice to make note of it for others to keep up with the changes. For that, we utilize the `CHANGELOG.md` file in the root directory. This file is used to list changes made in each version of the project and there are headers that we use to denote each type of change.

- **Added:** for new features.
- **Changed:** for changes in existing functionality.
- **Deprecated:** for soon-to-be removed features.
Expand Down Expand Up @@ -171,19 +162,11 @@ First, click on `compare across forks` and select the right repositories and bra

![compare-across-forks](../assets/images/community/contributing/compare-across-forks.PNG)

Then, fill in the pull request template. In the title, add the feat, bug or docs prefix depending on the type of modification. A general template will be shown, please click on `Preview` and choose the corresponding pull request template. In addition, on the right side, you can select a reviewer (for instance, if you discussed the issue with a member of the Argilla team) and assign the pull request to yourself.

It is highly advisable to add labels to PR as well. You can do this again by the labels section right to the screen. For instance, if you are addressing a bug, add the `bug` label or if the PR is related to the documentation, add the `documentation` label. This way, PRs can be easily filtered.

Additionally, you should add a prefix to the PR name as we did with the branch above. If you are working on a new feature, you can name your PR as `feat: TITLE`. If your PR consists of a solution for a bug, you can name your PR as `bug: TITLE` And, if your work is for improving the documentation, you can name your PR as `docs: TITLE`.

Finally, click on `Create pull request`.

![pr](../assets/images/community/contributing/pull-request.PNG)
Then, fill in the pull request template. You should add a prefix to the PR name as we did with the branch above. If you are working on a new feature, you can name your PR as `feat: TITLE`. If your PR consists of a solution for a bug, you can name your PR as `bug: TITLE` And, if your work is for improving the documentation, you can name your PR as `docs: TITLE`.

Below, we chose the feature template. Now, fill in it carefully and follow the guidelines. Remember to link the original issue. Finally, enable the checkbox to allow maintainer edits so the branch can be updated for a merge and click on `Create pull request`.
In addition, on the right side, you can select a reviewer (for instance, if you discussed the issue with a member of the Argilla team) and assign the pull request to yourself. It is highly advisable to add labels to PR as well. You can do this again by the labels section right to the screen. For instance, if you are addressing a bug, add the `bug` label or if the PR is related to the documentation, add the `documentation` label. This way, PRs can be easily filtered.

![pr-feature-template](../assets/images/community/contributing/pull-request-feature.PNG)
Finally, fill in the template carefully and follow the guidelines. Remember to link the original issue and enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Then, click on `Create pull request`.


### Review your pull request
Expand All @@ -209,7 +192,7 @@ Additionally, we will include your changes in the next release based on our [dev

Here are some helpful resources for your reference.

* [Configuring Slack](https://slack.com/help/articles/218080037-Getting-started-for-new-Slack-users), a guide to learn how to configure Slack.
* [Configuring Discord](https://support.discord.com/hc/en-us/categories/115000217151), a guide to learn how to get started with Discord.
* [Pro Git](https://git-scm.com/book/en/v2), a book to learn Git.
* [Git in VSCode](https://code.visualstudio.com/docs/sourcecontrol/overview), a guide to learn how to easily use Git in VSCode.
* [GitHub Skills](https://skills.github.com/), an interactive course to learn GitHub.
6 changes: 3 additions & 3 deletions argilla/docs/community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ We are an open-source community-driven project not only focused on building a gr

<div class="grid cards" markdown>

- __Slack__
- __Discord__

---

In our Slack you can get direct support from the community.
In our Discord channels (#argilla-general and #argilla-help), you can get direct support from the community.


[:octicons-arrow-right-24: Slack ↗](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g)
[:octicons-arrow-right-24: Discord ↗](http://hf.co/join/discord)

- __Community Meetup__

Expand Down
4 changes: 2 additions & 2 deletions argilla/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ extra:
link: https://twitter.com/argilla_io
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/channel/UCAIz8TmvQQrLqbD7sd-5S2A
- icon: fontawesome/brands/slack
link: https://join.slack.com/t/rubrixworkspace/shared_invite/zt-20wllqq29-Z11~kp2SeFYjJ0qevJRiPg
- icon: fontawesome/brands/discord
link: http://hf.co/join/discord

extra_css:
- stylesheets/extra.css
Expand Down
6 changes: 1 addition & 5 deletions docs/_source/404.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,4 @@ Oops! Something is missing.

We are not perfect so we love to get feedback. Do you feel anything is
missing in our documentation or do you simply want some help? Feel free
to contact our favorite developer advocate David, via
`email <mailto:[email protected]>`__,
`Slack <https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g>`__,
or by scheduling a video meeting in his
`Calendly <https://calendly.com/argumentation-at-argilla/30min>`__.
to contact via `Discord <http://hf.co/join/discord>`__.
2 changes: 1 addition & 1 deletion docs/_source/_common/general.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
We are not perfect so we love to get feedback.\
Do you feel anything is missing in our documentation or do you simply want some help? \
Feel free to contact our favorite developer advocate David, via [email](mailto:[email protected]), [Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g), or by scheduling a video meeting in his [Calendly](https://calendly.com/argumentation-at-argilla/30min).
Feel free to contact our favorite developer advocates David or Sara via [Discord](http://hf.co/join/discord).
4 changes: 2 additions & 2 deletions docs/_source/_common/next_steps.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
<h2>Next steps<a class="headerlink" href="#Next-steps" title="Permalink to this headline">#</a></h2>
<p>If you want to continue learning Argilla:</p>
<p>🙋‍♀️ Join the <a class="reference external"
href="https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g">Argilla
Slack community</a>!</p>
href="http://hf.co/join/discord">Argilla
Discord community</a>!</p>
<p>⭐ Argilla <a class="reference external" href="https://github.com/argilla-io/argilla">Github repo</a> to stay
updated.</p>
<p>📚 <a class="reference external" href="https://docs.argilla.io">Argilla documentation</a> for more guides and
Expand Down
2 changes: 1 addition & 1 deletion docs/_source/_common/next_steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
tabindex="0"
></iframe>

🙋‍♀️ Join the Argilla community on [Slack](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g) and get direct support from the community.
🙋‍♀️ Join the Argilla community on [Discord](http://hf.co/join/discord) and get direct support from the community in #argilla-general and #argilla-help.

⭐ Argilla [Github repo](https://github.com/argilla-io/argilla) to stay updated about new releases and tutorials.

Expand Down
2 changes: 1 addition & 1 deletion docs/_source/_common/snippets/start_page.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Argilla is a platform for building high-quality AI datasets

If you need support join the [Argilla Slack community](https://join.slack.com/t/rubrixworkspace/shared_invite/zt-whigkyjn-a3IUJLD7gDbTZ0rKlvcJ5g)
If you need support join the [Argilla Discord community](http://hf.co/join/discord)

</div>

Expand Down
Loading
Loading