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

Updates to README, profile, & ONBOARDING files #213

Merged
merged 4 commits into from
Aug 16, 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
9 changes: 6 additions & 3 deletions ONBOARDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
- [Resources and links](#resources-and-links)
- [Set up accounts and access](#set-up-accounts-and-access)
- [GitHub account](#github-account)
- [OpenSearch forum account](#opensearch-forum-account)
- [OpenSearch forum and Slack accounts](#opensearch-forum-and-slack-accounts)

# Getting started as an OpenSearch contributor

Expand Down Expand Up @@ -81,8 +81,11 @@ To create issues, leave comments, or submit pull requests, you'll need a GitHub
4. Recommended - Do (8 min) [Configure 2-factor authentication](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication)
5. Optional - Read (5 min) If you're new to using GitHub or git, we recommend reviewing “[Using GitHub's tools and processes](https://docs.github.com/en/get-started/onboarding/getting-started-with-your-github-account#part-2-using-githubs-tools-and-processes)”

### OpenSearch forum account
### OpenSearch forum and Slack accounts

There are multiple ways to [connect with the OpenSearch community](https://opensearch.org/connect.html), but [the forum](https://forum.opensearch.org/) is the best place to start
There are multiple ways to [connect with the OpenSearch community](https://opensearch.org/connect.html), [the forum](https://forum.opensearch.org/) and [Slack](https://www.opensearch.org/slack.html) are the best places to start.

- **Do (2 min)** [create an OpenSearch forum](https://forum.opensearch.org/) account
- **Do (2 min)** [create an OpenSearch Slack](https://www.opensearch.org/slack.html) account

Refer to the ['COMMUNICATIONS'](https://github.com/opensearch-project/community/blob/main/COMMUNICATIONS.md) file for additional information.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
* [Downloads](https://opensearch.org/downloads.html)
* [Documentation](https://opensearch.org/docs/latest/)
* Need help? Try [Forums](https://forum.opensearch.org/)
* Talk to other developers? [Slack](https://opensearch.org/slack.html)
* [Communications](https://github.com/opensearch-project/community/blob/main/COMMUNICATIONS.md)
* [Project Principles](https://opensearch.org/about.html#principles-for-development)
* [Contributing to OpenSearch](CONTRIBUTING.md)
* [Proposing Features](FEATURES.md)
Expand Down
7 changes: 5 additions & 2 deletions profile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ OpenSearch is a community-driven, Apache 2.0-licensed open source search and ana
We are built 🧱 by the community for the community. If you would like to contribute there are many ways:

- We have [a step-by-step onboarding guide](../ONBOARDING.md) to help you get oriented and prepared to contribute.
- 👀 Check out a project's `CONTRIBUTING.md` file to learn how to contribute.
- 👀 Check out a project's [`CONTRIBUTING.md`](../CONTRIBUTING.md) file to learn how to contribute.
- [Blogs](https://github.com/opensearch-project/project-website) and [Documentation Updates](https://github.com/opensearch-project/documentation-website)!
- Finally, make sure to try [OpenSearch](https://opensearch.org/docs/latest/opensearch/install/docker/) 🔎, [OpenSearch Dashboards](https://playground.opensearch.org/auth/anonymous) 🖥, and our Plugins/Client Libraries 📚 and leave feedback!

Expand All @@ -16,9 +16,12 @@ We are built 🧱 by the community for the community. If you would like to contr
There are several places where our community meets make sure to check them out!

- 📝 [Forum](https://forum.opensearch.org/)
- 💬 [Slack](https://opensearch.org/slack.html)
- 🗣️ [User Groups & Triage meetings](https://www.meetup.com/pro/opensearchproject/)
- ▶️ [YouTube](https://www.youtube.com/c/OpenSearchProject)
- 🐤 [Twitter](https://twitter.com/OpenSearchProj)
- 🧑‍💼 [LinkedIn](https://www.linkedin.com/company/opensearch-project/)
- 🐘 [Mastodon](https://fosstodon.org/@OpenSearchProject)
- 🐤 [Twitter](https://twitter.com/OpenSearchProj)

----

Expand Down
Loading