Skip to content

Commit

Permalink
Add Getting Started section to the Developer Guide (#685) (#692)
Browse files Browse the repository at this point in the history
* Add development environment setup link to Welcome section of the README.
* Remove broken Admin Responsibilities link from the README.

Resolves #666

Signed-off-by: Tommy Markley <markleyt@amazon.com>
Tommy Markley authored Aug 3, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 933c415 commit 01ae6f3
Showing 2 changed files with 30 additions and 6 deletions.
32 changes: 28 additions & 4 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,45 @@
# OpenSearch Dashboards Developer Guide

This guide applies to all development within the OpenSearch Dashboards project and is
recommended for the development of all OpenSearch Dashboards plugins.
This guide applies to all development within the OpenSearch Dashboards project and is recommended for the development of all OpenSearch Dashboards plugins.

- [Getting Started](#getting-started)
- [General](#general)
- [HTML](#html)
- [API endpoints](#api-endpoints)
- [TypeScript/JavaScript](#typeScript/javaScript)
- [SASS files](#sass-files)
- [React](#react)

Besides the content in this developer guide, the following developer guides may also apply
to all development within the OpenSearch Dashboards project. Please make sure to also read them:
Besides the content in this developer guide, the following developer guides may also apply to all development within the OpenSearch Dashboards project. Please make sure to also read them:

- [Accessibility developer guide (EUI Docs)](https://elastic.github.io/eui/#/guidelines/accessibility)
- [SASS developer guide (EUI Docs)](https://elastic.github.io/eui/#/guidelines/sass)

## Getting Started

If you would like to install and run this project, please see the [Downloads Page](https://opensearch.org/downloads.html).

### Run OpenSearch
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```

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 directory

### Run 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
* ```curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash```
* ```nvm install v10.24.1```
* [Yarn](https://classic.yarnpkg.com/en/docs/install) is required for building and running the OpenSearch Dashboards
* ```npm install -g yarn```
* Run ```yarn osd bootstrap``` in the OpenSearch Dashboards directory
* While OpenSearch is running locally, run ```yarn start```
* You can now navigate to ```http://localhost:5601``` where Dashboards runs by default

## General

### Filenames
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@

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).
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), [set up your development environment](DEVELOPER_GUIDE.md#getting-started), or [start contributing](CONTRIBUTING.md).

## Project Resources

@@ -19,10 +19,10 @@ Feel free to take a look at what the community has been up to, and then head ove
* [Documentation](https://opensearch.org/docs/)
* Need help? Try [Forums](https://discuss.opendistrocommunity.dev/)
* [Project Principles](https://opensearch.org/#principles)
* [Developer Guide](DEVELOPER_GUIDE.md)
* [Contributing to OpenSearch](CONTRIBUTING.md)
* [Maintainer Responsibilities](MAINTAINERS.md)
* [Release Management](RELEASING.md)
* [Admin Responsibilities](ADMINS.md)
* [Testing](TESTING.md)
* [Security](SECURITY.md)

0 comments on commit 01ae6f3

Please sign in to comment.