Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BUG] Developer guide does not have instructions on how to build Dashboards locally #666

Closed
ashwin-pc opened this issue Jul 23, 2021 · 2 comments · Fixed by #685
Closed

[BUG] Developer guide does not have instructions on how to build Dashboards locally #666

ashwin-pc opened this issue Jul 23, 2021 · 2 comments · Fixed by #685
Assignees
@tmarkley
Labels
bug Something isn't working docs Improvements or additions to documentation

Comments

@ashwin-pc
Copy link
Member

ashwin-pc commented Jul 23, 2021 •
edited by tmarkley
Loading

Describe the bug

There are no instructions on DEVELOPER_GUIDE.md for how to build OpenSearch Dashboards locally. The Developer Guide for OpenSearch core does include these instructions. I also could not find these instructions anywhere else.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://github.com/ashwin-pc/OpenSearch-Dashboards/blob/main/DEVELOPER_GUIDE.md
  2. No instructions on how to build and run the OpenSearch Dashboards code

Expected behavior
Documentation similar to Open Search core on how to build and run OpenSearch Dashboards. Instruction on how to run the other scripts would also be useful here e.g. tests, storybook
@ashwin-pc ashwin-pc added bug Something isn't working untriaged labels Jul 23, 2021
@tmarkley tmarkley self-assigned this Jul 26, 2021
@tmarkley tmarkley added docs Improvements or additions to documentation and removed untriaged labels Jul 26, 2021
@kavilla kavilla mentioned this issue Jul 26, 2021
Closed
@tmarkley
Copy link
Contributor

Hi Ashwin, thanks for documenting this! We had some instructions in the README.md but recently edited that. I'll add them to the DEVELOPER_GUIDE and add a link in the README.

tmarkley pushed a commit to tmarkley/OpenSearch-Dashboards that referenced this issue Jul 29, 2021
Add Getting Started section to Developer Guide
1f38879 
* Add development environment setup link to Welcome section of README.
* Remove broken Admin Responsibilities link from README

Resolves opensearch-project#666

Signed-off-by: Tommy Markley <[email protected]>
@tmarkley tmarkley mentioned this issue Jul 29, 2021
Merged
1 task
@waynehamadi
Copy link
Contributor

For anyone having this kind of issue, you can change versions on github, and see if the install instructions are present.

I found them here https://github.com/opensearch-project/OpenSearch-Dashboards/tree/1.0.0-beta1

Granted, they might be different now, but it's better than nothing.

tmarkley pushed a commit to tmarkley/OpenSearch-Dashboards that referenced this issue Aug 3, 2021
Add Getting Started section to the Developer Guide
68b7916 
* Add development environment setup link to Welcome section of the README.
* Remove broken Admin Responsibilities link from the README.

Resolves opensearch-project#666

Signed-off-by: Tommy Markley <[email protected]>
tmarkley pushed a commit that referenced this issue Aug 3, 2021
Add Getting Started section to the Developer Guide (#685)
07ea9f4 
* Add development environment setup link to Welcome section of the README.
* Remove broken Admin Responsibilities link from the README.

Resolves #666

Signed-off-by: Tommy Markley <[email protected]>
tmarkley pushed a commit to tmarkley/OpenSearch-Dashboards that referenced this issue Aug 3, 2021
Add Getting Started section to the Developer Guide (opensearch-projec…
cc2cee4 
…t#685)

* Add development environment setup link to Welcome section of the README.
* Remove broken Admin Responsibilities link from the README.

Resolves opensearch-project#666

Signed-off-by: Tommy Markley <[email protected]>
tmarkley pushed a commit that referenced this issue Aug 3, 2021
Add Getting Started section to the Developer Guide (#685) (#692)
01ae6f3 
* Add development environment setup link to Welcome section of the README.
* Remove broken Admin Responsibilities link from the README.

Resolves #666

Signed-off-by: Tommy Markley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tmarkley tmarkley

Labels
bug Something isn't working docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Getting Started section to the Developer Guide tmarkley/OpenSearch-Dashboards
3 participants
@tmarkley @waynehamadi @ashwin-pc