diff --git a/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md index 1d2ea2d2f5d..973305be64a 100644 --- a/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/BUG_TEMPLATE.md @@ -1,6 +1,6 @@ --- -name: πŸ› Bug report -about: Create a report to help us improve +name: πŸ› Bug Report +about: Create a report to help us improve. title: '[BUG]' labels: 'bug, untriaged' assignees: '' diff --git a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md index 55b3ddf3b8d..c0f0dfcbb2b 100644 --- a/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md @@ -1,6 +1,6 @@ --- -name: πŸŽ† Feature request -about: Request a feature in this project +name: πŸŽ† Feature Request +about: Request a feature in this project. title: '[FEATURE]' labels: 'enhancement, untriaged' assignees: '' diff --git a/.github/ISSUE_TEMPLATE/PROPOSAL_TEMPLATE.md b/.github/ISSUE_TEMPLATE/PROPOSAL_TEMPLATE.md index 9276d050bd5..7a22a97fcd8 100644 --- a/.github/ISSUE_TEMPLATE/PROPOSAL_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE/PROPOSAL_TEMPLATE.md @@ -1,6 +1,6 @@ --- name: πŸ’­ Proposal -about: Suggest an idea for a specific feature you wish to propose to the community for comment +about: Suggest an idea for a specific feature you wish to propose to the community for comment. title: '[PROPOSAL]' labels: proposal assignees: '' @@ -10,19 +10,19 @@ assignees: '' _In a few sentences, describe the feature and its core capabilities._ ### What users have asked for this feature? -_Highlight any research, proposals, requests or anecdotes that signal this is the right thing to build. Include links to GitHub Issues, Forums, Stack Overflow, Twitter, Etc_ +_Highlight any research, proposals, requests or anecdotes that signal this is the right thing to build. Include links to GitHub Issues, Forums, Stack Overflow, Twitter, etc._ ### What problems are you trying to solve? -_Summarize the core use cases and user problems and needs you are trying to solve. Describe the most important user needs, pain points and jobs as expressed by the user asks above. Template: When \ , a \ wants to \, so they can \. (Example: When **searching by postal code**, **a buyer** wants to **be required to enter a valid code** so they **don’t waste time searching for a clearly invalid postal code.**)_ +_Summarize the core use cases and user problems and needs you are trying to solve. Describe the most important user needs, pain points and jobs as expressed by the user asks above. Template: When \ , a \ wants to \, so they can \ (e.g. When **searching by postal code**, **a buyer** wants to **be required to enter a valid code** so they **don’t waste time searching for a clearly invalid postal code.**)._ ### What is the developer experience going to be? _Does this have a REST API? If so, please describe the API and any impact it may have to existing APIs. In a brief summary (not a spec), highlight what new REST APIs or changes to REST APIs are planned. as well as any other API, CLI or Configuration changes that are planned as part of this feature._ #### Are there any security considerations? -_Describe if the feature has any security considerations or impact. What is the security model of the new APIs? Features should be integrated into the OpenSearch security suite and so if they are not, we should highlight the reasons here._ +_Describe whether the feature has any security considerations or impact. What is the security model of the new APIs? Features should be integrated into the OpenSearch security suite and so if they are not, we should highlight the reasons here._ #### Are there any breaking changes to the API -_If this feature will require breaking changes to any APIs, ouline what those are and why they are needed. What is the path to minimizing impact? (example, add new API and deprecate the old one)_ +_If this feature will require breaking changes to any APIs, outline what those will be and why they are needed. What is the path to minimizing impact? (e.g. add new API and deprecate the old one)._ ### What is the user experience going to be? _Describe the feature requirements and or user stories. You may include low-fidelity sketches, wireframes, APIs stubs, or other examples of how a user would use the feature via CLI, OpenSearch Dashboards, REST API, etc. Using a bulleted list or simple diagrams to outline features is okay. If this is net new functionality, call this out as well._ diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 67f6e2a3267..33bffe678ac 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,7 +1,10 @@ contact_links: - - name: OpenSearch Community Support - url: https://discuss.opendistrocommunity.dev/ - about: Please ask and answer questions here. - - name: AWS/Amazon Security - url: https://aws.amazon.com/security/vulnerability-reporting/ - about: Please report security vulnerabilities here. + - name: πŸ’¬ OpenSearch Community Slack Workspace + url: https://opensearch.org/slack.html + about: Chat with community members and maintainers here. + - name: 🀷 OpenSearch Community Forum + url: https://forum.opensearch.org/ + about: Ask and answer OpenSearch usage questions here. + - name: πŸ” Report a Security Issue + url: https://github.com/opensearch-project/.github/blob/main/SECURITY.md + about: Please e-mail security@opensearch.org. Do not create a public GitHub issue. diff --git a/.github/workflows/bake_time.yml b/.github/workflows/bake_time.yml index 6c0f33798ca..94f48c79c9d 100644 --- a/.github/workflows/bake_time.yml +++ b/.github/workflows/bake_time.yml @@ -11,10 +11,10 @@ on: jobs: baking_pull_request: - name: "Baking pull request..." + name: "Baking pull request ..." runs-on: ubuntu-latest steps: - uses: peternied/bake-time@v3 with: - check-name: "Baking pull request..." + check-name: "Baking pull request ..." delay-hours: 48 diff --git a/.github/workflows/link-checker.yml b/.github/workflows/link-checker.yml index 7b243e6fd2a..de878d01216 100644 --- a/.github/workflows/link-checker.yml +++ b/.github/workflows/link-checker.yml @@ -6,12 +6,12 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - - name: lychee Link Checker + - name: Lychee Link Checker id: lychee uses: lycheeverse/lychee-action@master with: args: --accept=200,403,429 "./**/*.md" "./**/*.txt" env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Fail if there were link errors + - name: Fail if there were link errors. run: exit ${{ steps.lychee.outputs.exit_code }} diff --git a/ADMINS.md b/ADMINS.md index dc748e8f0d2..cc8e913c49d 100644 --- a/ADMINS.md +++ b/ADMINS.md @@ -46,14 +46,14 @@ Please note that maintainers typically do not have admin-level permissions in th ### Adopt Organizational Practices -Adopt organizational practices documented in this repo, work in the open, and collaborate with other admins by opening issues before making process changes. Prefer consistency, and avoid diverging from practices in the opensearch-project rganization. +Adopt organizational practices documented in this repo, work in the open, and collaborate with other admins by opening issues before making process changes. Prefer consistency, and avoid diverging from practices in the opensearch-project organization. ## New Repos There are currently two ways new repositories may appear in the opensearch-project organization: creating a new repo and adopting, or moving a repo from outside of the organization into it. The process is the same. -The AWS Open Source Program Office (OSPO) currently owns and manages the opensearch-project organization, and has permissions to create a new repo. While the admins above have admin-level permissions, they do not have permissions to create new repositories or move repositories into the organization. +The AWS Open Source Program Office (OSPO) currently owns and manages the opensearch-project organization, and has permissions to create a new repo. This will change shortly following the [formation of the OpenSearch Software Foundation](https://foundation.opensearch.org/). While the admins above have admin-level permissions, they do not have permissions to create new repositories or move repositories into the organization. All new repositories inside opensearch-project follow the [security response process](SECURITY.md), and therefore require an Amazon team to be engaged when necessary. If you wish to create a repository in this organization, or move a repository into opensearch-project, please contact one of the above-mentioned admins via the [#maintainers channel on the public Slack](https://opensearch.slack.com/archives/C05L60S4UBT). -While the opensearch-project organization has adopted [opensearch-plugin-template-java](https://github.com/opensearch-project/opensearch-plugin-template-java), or [opensearch-project/opensearch-learning-to-rank-base](https://github.com/opensearch-project/opensearch-learning-to-rank-base) in the past, we generally encourage you to start and run with your open-source project outside of the organization, and only consider making it part of it when you wish to include your already very popular component or tool in the "official" distribution. +While the opensearch-project organization has adopted [opensearch-plugin-template-java](https://github.com/opensearch-project/opensearch-plugin-template-java), or [opensearch-project/opensearch-learning-to-rank-base](https://github.com/opensearch-project/opensearch-learning-to-rank-base) in the past, we generally encourage you to start and run with your open-source project outside of the organization, and only consider making it part of it when you wish to include your already very popular component or tool in the "official" distribution. To request moving a repo into this organization, please open a proposal in your repo, have repo maintainers confirm they wish to move, and engage admins via the [#admin-requests channel on the public Slack](https://opensearch.slack.com/archives/C051CKVFB2A). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 53e19a65bc7..a67d1a3d5e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ ## Contributing to OpenSearch -OpenSearch is a community project that is built and maintained by people just like **you**. We're glad you're interested in helping out. There are several different ways you can do it, but before we talk about that, let's talk about how to get started. +OpenSearch, a member of non-profit Linux Foundation, is a community project that is built and maintained by people just like **you**. We're glad you're interested in helping out. There are several different ways you can do it, but before we talk about that, let's talk about how to get started. ## First Things First diff --git a/ONBOARDING.md b/ONBOARDING.md index 60b1cc128a2..fbdadde9b09 100644 --- a/ONBOARDING.md +++ b/ONBOARDING.md @@ -1,41 +1,43 @@ -- [Introduction](#introduction) - - [Who this is for](#who-this-is-for) - - [What this guide will help you do](#what-this-guide-will-help-you-do) -- [Learn key concepts](#learn-key-concepts) - - [About the OpenSearch project](#about-the-opensearch-project) - - [How we work](#how-we-work) - - [Contributor expectations](#contributor-expectations) - - [Resources and links](#resources-and-links) -- [Set up accounts and access](#set-up-accounts-and-access) - - [GitHub account](#github-account) - - [OpenSearch forum and Slack accounts](#opensearch-forum-and-slack-accounts) - -# Getting started as an OpenSearch contributor +- [Getting Started as an OpenSearch Project Contributor](#getting-started-as-an-opensearch-project-contributor) + - [Introduction](#introduction) + - [Who is this for?](#who-is-this-for) + - [What will this guide help you do?](#what-will-this-guide-help-you-do) + - [Key Concepts](#key-concepts) + - [About the OpenSearch Project](#about-the-opensearch-project) + - [How We Work](#how-we-work) + - [Contributor Expectations](#contributor-expectations) + - [Resources and Links](#resources-and-links) + - [Set Up Accounts and Access](#set-up-accounts-and-access) + - [GitHub Account](#github-account) + - [OpenSearch Forum and Slack Accounts](#opensearch-forum-and-slack-accounts) + +# Getting Started as an OpenSearch Project Contributor ## Introduction -### Who this is for +### Who is this for? -Any developer who's interested in contributing code (features and fixes) to one of the OpenSearch open source project repositories for the first time. +Anyone who's interested in contributing code (features, fixes, documentation) to one of the OpenSearch Project open-source repositories for the first time. -### What this guide will help you do +### What will this guide help you do? -1. Understand the key concepts of the OpenSearch project and how to find additional resources -2. Set up the accounts you'll need to contribute +1. Understanding the key concepts of the OpenSearch Project and how to find additional resources. +2. Set up the accounts you'll need to contribute. -## Learn key concepts +## Key Concepts -### About the OpenSearch project +### About the OpenSearch Project -- **Read (3 min) [the project homepage](https://opensearch.org/)** to get a sense of what the OpenSearch software does and how it's used -- **Read (4 min) β€œ[About OpenSearch](https://opensearch.org/about.html)”** to understand the primary project components and development principles +- **Read (3 min) [the project homepage](https://opensearch.org/)** to get a sense of what the OpenSearch software does and how it's used. +- **Read (4 min) "[About OpenSearch](https://opensearch.org/about.html)"** to understand the primary project components and development principles. - Optional - Read founding documents to understand the project history - - Read (8 min) β€œ[Introducing OpenSearch](https://aws.amazon.com/blogs/opensource/introducing-opensearch/)” from 2021-04-12 - - Read (6 min) β€œ[Stepping up for a truly open source Elasticsearch](https://aws.amazon.com/blogs/opensource/stepping-up-for-a-truly-open-source-elasticsearch/)” from 2021-01-21 + - Read (2 min) "[Linux Foundation Announces OpenSearch Software Foundation](https://www.linuxfoundation.org/press/linux-foundation-announces-opensearch-software-foundation-to-foster-open-collaboration-in-search-and-analytics) from September, 2024. + - Read (8 min) "[Introducing OpenSearch](https://aws.amazon.com/blogs/opensource/introducing-opensearch/)" from April, 2021. + - Read (6 min) "[Stepping up for a truly open source Elasticsearch](https://aws.amazon.com/blogs/opensource/stepping-up-for-a-truly-open-source-elasticsearch/)" from January, 2021. -### How we work +### How We Work -We model our way of working on β€œ[the Apache Way](https://apache.org/theapacheway)” (optional - read 4 min). Specifically, we've borrowed and adapted: +We model our way of working on "[the Apache Way](https://apache.org/theapacheway)" (optional - read 4 min). Specifically, we've borrowed and adapted: - *Community Over Code:* A healthy community is a higher priority than good code. Strong communities can always rectify problems with their code, whereas an unhealthy community will likely struggle to maintain a codebase in a sustainable manner. - *Earned Authority:* All individuals are given the opportunity to participate, but their influence is based on publicly earned merit – what they contribute to the community. Merit lies with the individual, does not expire, is not influenced by employment status or employer, and is non-transferable (merit earned in one project cannot be applied to another). @@ -43,49 +45,46 @@ We model our way of working on β€œ[the Apache Way](https://apache.org/theapachew - *Community of Peers:* Individuals participate, not organizations. Roles are equal irrespective of title, votes hold equal weight, and contributions are made on a voluntary basis (even if paid to work on code). - *Progress over Perfection:* Struggling with a test failure? Can't quite figure out why that data structure isn't doing what you expect? Feeling defeated by the complexities of that massively distributed compute engine? The community idea exists to help each other through difficult problems. So fail early, commit often, ask for help, and don't be afraid. -### Contributor expectations +### Contributor Expectations Contributors are subject to a code of conduct, and it's essential that all contributions are original work. -- **Read (6 min) [the OpenSearch code of conduct](https://opensearch.org/codeofconduct.html)** -- **Read (6 min) [the OpenSearch CONTRIBUTING guide](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md)** - - Please make sure you understand the implications of the [Developer Certificate of Origin](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin) +- **Read (6 min) [the OpenSearch Code of Conduct](https://opensearch.org/codeofconduct.html)**. +- **Read (6 min) [the OpenSearch CONTRIBUTING Guide](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md)**. Please make sure you understand the implications of the [Developer Certificate of Origin](https://github.com/opensearch-project/.github/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). -### Resources and links +### Resources and Links -There are more than 90 [GitHub repositories](https://github.com/orgs/opensearch-project/repositories?q=&type=public&language=&sort=) that are part of the OpenSearch project. Explore the list to get a sense of the project breadth and scope. +There are more than 100 [GitHub repositories](https://github.com/orgs/opensearch-project/repositories?q=&type=public&language=&sort=) that are part of the OpenSearch project. Explore the list to get a sense of the project breadth and scope. -- The [roadmap](https://github.com/orgs/opensearch-project/projects/1) provides a single place to keep track of upcoming releases and current projects +- The [roadmap](https://github.com/orgs/opensearch-project/projects/220) provides a single place to keep track of upcoming releases and current projects. -Looking for answers? While [the forum](https://forum.opensearch.org/) is always a good option, it's worth checking these first +Looking for answers? While [the forum](https://forum.opensearch.org/) and [Slack](https://opensearch.org/slack.html) are always a good option, it's worth checking these first. -- [Frequently Asked Questions](https://opensearch.org/faq) -- [User documentation](https://opensearch.org/docs/latest/) -- Developer documentation - - Start with `DEVELOPER_GUIDE.md` in the repository you'll be working in (see [OpenSearch](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md) or [OpenSearch Dashboards](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md) guides) +- [Frequently Asked Questions](https://opensearch.org/faq). +- [User Documentation](https://opensearch.org/docs/latest/). +- Developer Documentation + - Start with `DEVELOPER_GUIDE.md` in the repository you'll be working in (see [OpenSearch](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md) or [OpenSearch Dashboards](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md) guides). - Most repositories have many other documentation files. To find them, search for Markdown files (`*.md` - [example](https://github.com/search?q=repo%3Aopensearch-project%2FOpenSearch-Dashboards+language%3AMarkdown&type=code&l=Markdown)), either on GitHub or in your editor. -## Set up accounts and access +## Set Up Accounts and Access -### GitHub account +### GitHub Account To create issues, leave comments, or submit pull requests, you'll need a GitHub account. Already have a GitHub account? Great! If not, it's quick to get started. (We've summarized the most important steps for the OpenSearch project here, but for more complete information, see the [GitHub documentation](https://docs.github.com/en/get-started/onboarding/getting-started-with-your-github-account).) 1. **Do (2 min) Sign up for an account** by navigating to https://github.com/ and following the prompts ([source](https://docs.github.com/en/get-started/onboarding/getting-started-with-your-github-account#1-creating-an-account)). -2. **Do (4 min) [Verify your email address](https://docs.github.com/en/get-started/signing-up-for-github/verifying-your-email-address)** +2. **Do (4 min) [Verify your email address](https://docs.github.com/en/get-started/signing-up-for-github/verifying-your-email-address)**. 3. Recommended - Do (20 min) Set up GitHub to connect with SSH - 1. [Check for existing SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys) - 2. [Generate new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) - 3. [Add a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) - 4. [Test your SSH connection](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection) -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)” + 1. [Check for existing SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys). + 2. [Generate new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). + 3. [Add a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). + 4. [Test your SSH connection](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection). +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 and Slack accounts +### OpenSearch Forum and Slack Accounts 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. +- **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. diff --git a/README.md b/README.md index b91b0811726..ebc3be13b26 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,16 @@ ## Welcome! -**OpenSearch** is [a community-driven, open source fork](https://aws.amazon.com/blogs/opensource/introducing-opensearch/) of [Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch) and [Kibana](https://en.wikipedia.org/wiki/Kibana) licensed under the [Apache v2.0 License](LICENSE.txt). For more information, see [opensearch.org](https://opensearch.org/). +**OpenSearch Project** is [a community-driven, open source fork](https://aws.amazon.com/blogs/opensource/introducing-opensearch/) of [Elasticsearch](https://en.wikipedia.org/wiki/Elasticsearch) and [Kibana](https://en.wikipedia.org/wiki/Kibana) licensed under the [Apache v2.0 License](LICENSE.txt). + +OpenSearch is supported by [The OpenSearch Software Foundation](https://foundation.opensearch.org/), a project of [The Linux Foundation](https://www.linuxfoundation.org/). You can read the launch announcement [here](https://www.linuxfoundation.org/press/linux-foundation-announces-opensearch-software-foundation-to-foster-open-collaboration-in-search-and-analytics) and learn more about joining the foundation [here](https://foundation.opensearch.org/). + +For more information, see [opensearch.org](https://opensearch.org/). ## Project Resources * [Project Website](https://opensearch.org/) +* [OpenSearch Software Foundation](https://foundation.opensearch.org/) * [Downloads](https://opensearch.org/downloads.html) * [Documentation](https://opensearch.org/docs/latest/) * Need help? Try [Forums](https://forum.opensearch.org/) diff --git a/SECURITY.md b/SECURITY.md index e95b16c3f08..e211dbdeebb 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -30,7 +30,7 @@ The OpenSearch Security Team will address reported issues on a best effort basis Anyone finding an issue that is already publicly disclosed (for example, a CVE in one of the project’s dependencies) should feel free to create an issue and discuss openly on GitHub. The process below is only intended for issues that have not been publicly disclosed yet. 1. We request that instead of opening a GitHub issue, it is reported via email at security@opensearch.org. Please include a description of the issue, and any other information that could help in the reproduction and creation of a fix (version numbers, configuration values, reproduction steps...) -2. The OpenSearch Security Team will negotiate the conditions for an embargo period and a disclosure timeline with the discoverer (see [Embargo schedule](#embargo-schedule)). +2. The OpenSearch Security Team will negotiate the conditions for an embargo period and a disclosure timeline with the discoverer (see [Embargo Schedule](#embargo-schedule)). 3. After the vulnerability is confirmed, if no CVE number is already reserved, the OpenSearch Security Team will reserve one, and communicate it to the discoverer and all parties in the pre-disclosure list (see [Pre-disclosure list](#pre-disclosure-list)). 4. As soon as our advisory is available, we will send it, including patches, to members of the pre-disclosure list. In the event that we do not have a patch available 2 working weeks before the disclosure date, we aim to send an advisory that reflects the current state of knowledge to the pre-disclosure list. An updated advisory will be published as soon as available. At this stage, the advisory will be clearly marked with the embargo date. 5. On the day the embargo is lifted, we will publish the advisory and release the new versions containing the fix. @@ -85,5 +85,4 @@ Organizations who meet the criteria above (i.e. significant work needed post-dis * A statement to the effect that you have read this policy and agree to abide by the terms for inclusion in the list, specifically the requirements to regarding confidentiality during an embargo period * The email(s) you wish added to the pre-disclosure list - The OpenSearch Security Team will review your application and get back to you with their decision. diff --git a/profile/README.md b/profile/README.md index dc697f54ecd..7836a568ad1 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,19 +1,25 @@ ![OpenSearch logo and name on top of a dark blue background with a slight honeycomb pattern](https://raw.githubusercontent.com/opensearch-project/.github/main/profile/banner.jpg) -OpenSearch is a community-driven, Apache 2.0-licensed open source search and analytics suite that makes it easy to ingest, search, visualize, and analyze data. Developers build with OpenSearch for use cases such as application search, log analytics, data observability, data ingestion, and more. +OpenSearch Project is a community-driven, Apache 2.0-licensed open source search and analytics suite that makes it easy to ingest, search, visualize, and analyze data. Developers build with OpenSearch for use cases such as application search, log analytics, data observability, data ingestion, and more. + +OpenSearch is supported by [The OpenSearch Software Foundation](https://foundation.opensearch.org/), a project of [The Linux Foundation](https://www.linuxfoundation.org/). You can read the launch announcement [here](https://www.linuxfoundation.org/press/linux-foundation-announces-opensearch-software-foundation-to-foster-open-collaboration-in-search-and-analytics) and learn more about joining the foundation [here](https://foundation.opensearch.org/). + +## Using + +Download and try [OpenSearch](https://opensearch.org/docs/latest/opensearch/install/docker/) πŸ”Ž or use the demo [OpenSearch Dashboards](https://playground.opensearch.org/auth/anonymous) πŸ–₯. Integrate your application using one of many [client libraries](https://opensearch.org/docs/latest/clients/) πŸ“š. ## Contributing ✍️ -We are built 🧱 by the community for the community. If you would like to contribute there are many ways: +We are built 🧱 by the community for the community. There are many ways to contribute. -- 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`](../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! +- πŸ“– Read our [step-by-step onboarding guide](../ONBOARDING.md) to help you get oriented and prepared to contribute. +- πŸ‘€ Check out a project's [contributing guide](../CONTRIBUTING.md) to learn how to contribute code. +- ✍️ Write [a blog post](https://github.com/opensearch-project/project-website). +- πŸ“˜ Help author [documentation](https://github.com/opensearch-project/documentation-website). ## Get Involved in our Community! -There are several places where our community meets make sure to check them out! +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) @@ -25,4 +31,4 @@ There are several places where our community meets make sure to check them out! ---- -This project has adopted the [Amazon Open Source Code of Conduct](https://github.com/opensearch-project/.github/blob/main/CODE_OF_CONDUCT.md). Copyright OpenSearch Contributors. See [NOTICE](https://github.com/opensearch-project/.github/blob/main/NOTICE.txt) for details. OpenSearch is a registered trademark of Amazon Web Services. +This project has adopted the [OpenSearch Software Foundation Code of Conduct](https://github.com/opensearch-project/.github/blob/main/CODE_OF_CONDUCT.md). Copyright OpenSearch Contributors. See [NOTICE](https://github.com/opensearch-project/.github/blob/main/NOTICE.txt) for details. OpenSearch is a registered trademark of The Linux Foundation.