From 808a3b3ddee4b6748d488327d6edec4174540f51 Mon Sep 17 00:00:00 2001 From: Mihir Soni Date: Thu, 13 May 2021 10:57:57 -0700 Subject: [PATCH] [DOCS] Updated Readme and Contribution.md guide (#356) Signed-off-by: Mihir Soni --- CONTRIBUTING.md | 2 +- README.md | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08aa856fcdf1..14e6b256e8fa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,7 @@ If you've thought of a way that OpenSearch Dashboards could be better, we want t ### Documentation Changes -// TODO +If you would like to contribute to the documentation, please see [OpenSearch Docs repo](https://github.com/opensearch-project/documentation-website/blob/main/README.md). ### Contributing Code diff --git a/README.md b/README.md index 452fd831b22d..18dacfa08a5e 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,8 @@ Here are the principles we use to guide our development. From [opensearch.org]( ## 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) @@ -71,4 +73,5 @@ As we've been working, we've come up with a bunch of questions that we wanted to ### Questions? Feedback? -Let us know in the [forums](https://discuss.opendistrocommunity.dev/). w00t!!! +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!!!