From 08b293410f8cceaac7d553bae7f386f1b6ce4eaf Mon Sep 17 00:00:00 2001 From: Jonah Kowall Date: Wed, 14 Apr 2021 18:33:32 -0400 Subject: [PATCH] [Docs] Clarify instructions in README (#286) * 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 * Minor README fixed per discussion Removed "repo" from text and added https to the link Signed-off-by: Jonah Kowall jkowall@kowall.net --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f868db837d23..9cb62167d1eb 100644 --- a/README.md +++ b/README.md @@ -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