Skip to content

Commit

Permalink
[DOCS] Updated Readme and Contribution.md guide (#356)
Browse files Browse the repository at this point in the history
Signed-off-by: Mihir Soni <[email protected]>
  • Loading branch information
mihirsoni authored and kavilla committed May 21, 2021
1 parent 84800d8 commit 808a3b3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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!!!

0 comments on commit 808a3b3

Please sign in to comment.