From 659c199b93ff23695db40d62e477878e0cc8736b Mon Sep 17 00:00:00 2001 From: Abbas Hussain Date: Fri, 21 May 2021 04:27:07 +0530 Subject: [PATCH] Updating README and CONTRIBUTING guide to get ready for beta1 release. (#672) (#751) * Updating README and CONTRIBUTING guide to get ready for beta1 release. Signed-off-by: Sarat Vemulapalli * Addressing comments. Signed-off-by: Sarat Vemulapalli Co-authored-by: Sarat Vemulapalli --- CONTRIBUTING.md | 2 +- README.md | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41991fba0e1..c8dab3649ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ If you've thought of a way that OpenSearch could be better, we want to hear abou ### 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 22fb1033f6f..d9ad28c4d3e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,8 @@ We officially began work on the new fork on January 21st, 2021. Since then, we' ## Getting Started -If you would like to install or run this project please see the [Developer Guide](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md). There will be binary distributions coming soon which will enable faster installations. +If you would like to install and run this project, please see the [Downloads Page](https://opensearch.org/downloads.html). +If you would like to build, install and run this project please see the [Developer Guide](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md). ## Guiding Principles @@ -44,4 +45,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/). +Found a bug or need to leave feedback? Make sure you open an [issue](https://github.com/opensearch-project/OpenSearch/issues/new/choose). +Questions and discussions on this project can be found on the project [forums](https://discuss.opendistrocommunity.dev/).