forked from opensearch-project/OpenSearch-Dashboards
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Clean up README.md (opensearch-project#596)
* Add darkmode logo * Add a ToC and relevant sections * Add Project Resources to replace how can you help", "running tests", "guiding principles", etc. * Add CoC * Add License * Add Copyright Signed-off-by: Tommy Markley <[email protected]> Co-authored-by: Andrew Hopp <[email protected]>
- Loading branch information
Showing
1 changed file
with
26 additions
and
65 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1,39 @@ | ||
| # OpenSearch Dashboards | ||
| <img src="https://opensearch.org/assets/brand/SVG/Logo/opensearch_logo_darkmode.svg" height="64px"/> | ||
|
|
||
| Hello! | ||
| - [Welcome!](#welcome) | ||
| - [Project Resources](#project-resources) | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [License](#license) | ||
| - [Copyright](#copyright) | ||
|
|
||
| ## Welcome | ||
|
|
||
| OpenSearch Dashboards is an open source search and analytics visualization. We aim to to be the best community-driven platform and provide all the contributors a great open source experience. | ||
|
|
||
| Feel free to take a look at what the community has been up to, and then head over to the [Project Board](https://github.com/opensearch-project/OpenSearch-Dashboards/projects) to track 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). | ||
|
|
||
| ## Project Resources | ||
|
|
||
| ### Guiding Principles | ||
|
|
||
| Here are the principles we use to guide our development. From [opensearch.org](http://opensearch.org): | ||
|
|
||
|
|
||
| > 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 | ||
|
|
||
| If you would like to install and run this project, please see the [Downloads Page](https://opensearch.org/downloads.html). | ||
|
|
||
| To run OpenSearch Dashboards locally, you first need build artifacts from OpenSearch. | ||
| * Clone the OpenSearch repo with ```git clone https://github.com/opensearch-project/OpenSearch.git``` | ||
| * Follow installation and setup instructions in the [OpenSearch Developer Guide](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md) | ||
| * Run ```./gradlew assemble``` to generate build artifacts for all platforms | ||
| * Run ```./gradlew run -Drun.distribution=oss``` to run the oss build | ||
|
|
||
| Or | ||
| * You can also manually find the tar.gz file (.zip on Windows) at ```./distribution/archives/<platform-dir>/build/distributions``` and extract to your desired directory with ```tar -xvf /path/to/tar/file``` | ||
| * After extracting, run ```bin/opensearch``` inside of the extracted build artifact dir | ||
|
|
||
| To run Dashboards with OpenSearch | ||
| * [Yarn](https://classic.yarnpkg.com/en/docs/install) is required for building and running the OpenSearch Dashboards | ||
| * Install [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) to use the Node 10.24.1 version as it is required | ||
| * Run ```yarn osd bootstrap``` in the OpenSearch Dashboards directory | ||
| * While OpenSearch is running locally, run ```yarn start``` | ||
| * You can now navigate to ```http://localhost:5603``` where Dashboards runs by default | ||
| * If you pass ```--no-base-path``` then it will default to port 5601 | ||
|
|
||
| ## Running tests | ||
|
|
||
| ### Jest Unit Tests | ||
|
|
||
| Run the command ```yarn test:jest``` in the OpenSearch Dashboards project directory to run unit tests | ||
|
|
||
| ### Jest Integration Tests | ||
|
|
||
| For the integration tests, you must pass the absolute path of your extracted OpenSearch build artifacts through the ```TEST_OPENSEARCH_FROM``` env variable so that Dashboards can run an OpenSearch cluster. You can run: | ||
| ```TEST_OPENSEARCH_FROM=/path/to/extracted/build/artifact yarn test:jest_integration``` | ||
| * [Project Website](https://opensearch.org/) | ||
| * [Downloads](https://opensearch.org/downloads.html) | ||
| * [Documentation](https://opensearch.org/docs/) | ||
| * Need help? Try [Forums](https://discuss.opendistrocommunity.dev/) | ||
| * [Project Principles](https://opensearch.org/#principles) | ||
| * [Contributing to OpenSearch](CONTRIBUTING.md) | ||
| * [Maintainer Responsibilities](MAINTAINERS.md) | ||
| * [Release Management](RELEASING.md) | ||
| * [Admin Responsibilities](ADMINS.md) | ||
| * [Testing](TESTING.md) | ||
| * [Security](SECURITY.md) | ||
|
|
||
| ## How you can help | ||
| ## Code of Conduct | ||
|
|
||
| ### Look for the tag "help wanted" | ||
| This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
|
|
||
| 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). | ||
| ## License | ||
|
|
||
| ### 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! | ||
| This project is licensed under the [Apache v2.0 License](LICENSE.txt). | ||
|
|
||
| ### Questions? Feedback? | ||
| ## Copyright | ||
|
|
||
| Found a bug or need to leave feedback? Make sure you open an [issue](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/new/choose). | ||
| Questions and discussions on this project can be found on the project [forums](https://discuss.opendistrocommunity.dev/). w00t!!! | ||
| Copyright 2020-2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. |