Skip to content

Commit

Permalink
[Docs] Clarify instructions in README (opensearch-project#286)
Browse files Browse the repository at this point in the history
* Clarify instructions

Added link to the opensearch dev guide.
Fixed the URL for the clone to work for OpenSearch Dashboards

Signed-off-by: Jonah Kowall <[email protected]>

* Minor README fixed per discussion

Removed "repo" from text and added https to the link

Signed-off-by: Jonah Kowall [email protected]
  • Loading branch information
jkowall authored Apr 14, 2021
1 parent f77ded9 commit 08b2934
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Here are the principles we use to guide our development. From [opensearch.org](
## Getting Started

To run OpenSearch Dashboards locally, you first need build artifacts from OpenSearch.
* Clone the OpenSearch repo with ```git clone git@github.com:opensearch-project/OpenSearch.git```
* Follow installation and setup instructions in the OpenSearch repo
* Clone the OpenSearch repo with ```git clone https://github.com/opensearch-project/OpenSearch-Dashboards.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

Expand Down

0 comments on commit 08b2934

Please sign in to comment.