Skip to content

Commit

Permalink
docs: add docs for validating OUI changes in OpenSearch-Dashboards
Browse files Browse the repository at this point in the history
  • Loading branch information
Ubuntu committed May 21, 2024
1 parent 1d73920 commit 48fb172
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
1 change: 1 addition & 0 deletions DEVELOPER_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,5 +61,6 @@ yarn start --port 9000
* [Theming](wiki/theming.md)
* [Testing](wiki/testing.md)
* [Accessibility Testing](wiki/automated-accessibility-testing.md)
* [Validating with OpenSearch Dashboards](wiki/validating-with-opensearch-dashboards.md)
* [Documentation](wiki/documentation-guidelines.md)
* [Releasing versions](wiki/releasing-versions.md)
35 changes: 35 additions & 0 deletions wiki/validating-with-opensearch-dashboards.md
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!

0 comments on commit 48fb172

Please sign in to comment.