-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add docs for validating OUI changes in OpenSearch-Dashboards
- Loading branch information
Ubuntu
committed
May 21, 2024
1 parent
1d73920
commit 48fb172
Showing
2 changed files
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Validating with OpenSearch Dashboards | ||
|
||
The following are instructions for locally validating OUI changes within the | ||
[OpenSearch Dashboards](https://github.com/opensearch-project/OpenSearch-Dashboards) | ||
project. | ||
|
||
## Instructions | ||
|
||
To consume local OUI artifacts in OpenSearch Dashboards, and because there are | ||
some blockers to using `npm link` right now,`package.json` references to | ||
`opensearch-project/oui` will need to be updated to point to your local repo | ||
by running the following in `opensearch-project/OpenSearch-Dashboards`: | ||
|
||
```bash | ||
# Replace `<PATH TO>` below with a valid path to OUI | ||
find . -type f -name package.json -exec sed -i 's/"@elastic\/eui": ".*"/"@elastic\/eui": "file:\/<PATH TO>\/oui"/g' {} \; | ||
``` | ||
|
||
To see changes in OUI be reflected in Dashboards, first build release | ||
artifacts in `opensearch-project/oui`: | ||
|
||
```bash | ||
yarn build | ||
``` | ||
|
||
Then update OpenSearch Dashboards to consume them and restart your server by | ||
running the following in `opensearch-project/OpenSearch-Dashboards`: | ||
|
||
```bash | ||
yarn osd clean | ||
yarn osd bootstrap | ||
yarn start | ||
``` | ||
|
||
Changes from OUI should now be available in your local OpenSearch Dashboards server! |