diff --git a/README.md b/README.md index 44d00aa8067d..f868db837d23 100644 --- a/README.md +++ b/README.md @@ -2,38 +2,32 @@ Hello! -OpenSearch Dashboards is a visualization tool derived from Kibana 7.10.2. +OpenSearch Dashboards is an open source search and analytics visualization derived from Kibana 7.10.2, and is currently in an alpha state. While we're still in the process of getting set up, we are excited to build the best visualization platform for OpenSearch on the planet with you. -## Current State +We officially began work on the new fork on January 21st, 2021. Since then, we've been removing non-Apache 2.0 compliant code and doing a full rename of the project. Feel free to take a look at what we've been up to, and then head over to the [Project Board](https://github.com/opensearch-project/OpenSearch-Dashboards/projects) to track initial release targets, or jump in and [start opening issues](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/new/choose) or [contributing](https://github.com/opensearch-project/OpenSearch-Dashboards/blob/main/CONTRIBUTING.md). -We officially began work on the new fork on January 21st, 2021. Since then, we've been removing non-Apache 2.0 code and doing a full deep rename of the project. As this is an early phase, we don't expect the codebase to be bug free or to work perfectly. If you find an issue, feel free to open an issue [here](https://github.com/opensearch-project/OpenSearch-Dashboards/issues). +### Guiding Principles -## What works +Here are the principles we use to guide our development. From [opensearch.org](http://opensearch.org): -* All references to non-Apache 2.0 code should be removed. -* Core plugins (non-3rd party) -* New project name should be used everywhere. -* ```yarn osd bootstrap```, ESLint and commit hook should be passing. -* Jest Unit Tests -* Jest Integration Tests -* CI / CD with DCO check -## What doesn’t work - -* Functional test cases -* 3rd party plugins (including OpenDistro) - -## Guiding Principles - - -* **Great software.** If it doesn’t solve your problems, everything else is moot. It’s going to be software you love to use. -* **Open source like we mean it.** We are invested in this being a successful open source project for the long term. It’s all Apache 2.0. There’s no Contributor License Agreement. Easy. -* **A level playing field.** We will not tweak the software so that it runs better for any vendor (including AWS) at the expense of others. If this happens, call it out and we will fix it as a community. -* **Used everywhere.** Our goal is for as many people as possible to use it in their business, their software, and their projects. Use it however you want. Surprise us! -* **Made with your input.** We will ask for public input on direction, requirements, and implementation for any feature we build. -* **Open to contributions.** Great open source software is built together, with a diverse community of contributors. If you want to get involved at any level - big, small, or huge - we will find a way to make that happen. We don’t know what that looks like yet, and we look forward to figuring it out together. -* **Respectful, approachable, and friendly.** This will be a community where you will be heard, accepted, and valued, whether you are a new or experienced user or contributor. -* **A place to invent.** You will be able to innovate rapidly. This project will have a stable and predictable foundation that is modular, making it easy to extend. +> When we (the contributors) are successful, the OpenSearch project will be: +> +>**1. Great software**. If it doesn’t solve your problems, everything else is moot. It’s going to be software you love to use. +> +>**2. Open source like we mean it**. We are invested in this being a successful open source project for the long term. It’s all Apache 2.0. There’s no Contributor License >Agreement. Easy. +> +>**3. A level playing field**. We will not tweak the software so that it runs better for any vendor (including AWS) at the expense of others. If this happens, call it out and we >will fix it as a community. +> +>**4. Used everywhere**. Our goal is for as many people as possible to use it in their business, their software, and their projects. Use it however you want. Surprise us! +> +>**5. Made with your input**. We will ask for public input on direction, requirements, and implementation for any feature we build. +> +>**6. Open to contributions**. Great open source software is built together, with a diverse community of contributors. If you want to get involved at any level - big, small, or >huge - we will find a way to make that happen. We don’t know what that looks like yet, and we look forward to figuring it out together. +> +>**7. Respectful, approachable, and friendly**. This will be a community where you will be heard, accepted, and valued, whether you are a new or experienced user or contributor. +> +>**8. A place to invent**. You will be able to innovate rapidly. This project will have a stable and predictable foundation that is modular, making it easy to extend. ## Getting Started @@ -66,14 +60,13 @@ For the integration tests, you must pass the absolute path of your extracted Ope ## How you can help -### Look for the label "help wanted" - -If you're excited to jump in, we've tried to mark a few issues that would be good candidates to get started on. Look for the label "help wanted" to find them. https://github.com/opensearch-project/OpenSearch-Dashboards/labels/help%20wanted +### Look for the tag "help wanted" -### Watch the forum, there are a bunch of things we want to talk about +If you're excited to jump in, we've marked a few issues that would be [really helpful](https://github.com/opensearch-project/OpenSearch-Dashboards/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22). -As we've been working, we've come up with a bunch of questions that we wanted to get community feedback on. Now that we're done with this first pass of renaming, you'll see us posting those questions to the forum. Please let us know your thoughts! +### Watch the forum, because there are a bunch of things we want to talk about +As we've been working, we've come up with a bunch of questions that we wanted to get community feedback on. Now that we're done with this first pass of renaming, you'll see us posting those questions to the [forums](https://discuss.opendistrocommunity.dev/). Please let us know your thoughts! ### Questions? Feedback? -Let us know in the [forums](https://discuss.opendistrocommunity.dev/). w00t!!! +Let us know in the [forums](https://discuss.opendistrocommunity.dev/). w00t!!! \ No newline at end of file