Skip to content

Commit

Permalink
Delete kibana reference in commands
Browse files Browse the repository at this point in the history
Signed-off-by: abbyhu2000 <[email protected]>
  • Loading branch information
abbyhu2000 committed Feb 28, 2023
1 parent a657d1f commit 40d7d0e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions wiki/component-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ Refer to the [testing guide](testing.md) for guidelines on writing and designing

Refer to the [automated accessibility testing guide](automated-accessibility-testing.md) for info more info on those.

### Testing the component with Kibana
### Testing the component with OpenSearch Dashboards

Note that `yarn link` currently does not work with Kibana. You'll need to manually pack and insert it into Kibana to test locally.
Note that `yarn link` currently does not work with OpenSearch Dashboards. You'll need to manually pack and insert it into OpenSearch Dashboards to test locally.

#### In OUI run:

Expand All @@ -62,18 +62,18 @@ yarn build && npm pack

This will create a `.tgz` file with the changes in your OUI directory. At this point you can move it anywhere.

#### In Kibana:
#### In OpenSearch-Dashboards:

Point the `package.json` file in Kibana to that file: `"@opensearch-project/oui": "/path/to/elastic-oui-xx.x.x.tgz"`. Then run the following commands at Kibana's root folder:
Point the `package.json` file in OpenSearch Dashboards to that file: `"@opensearch-project/oui": "/path/to/elastic-oui-xx.x.x.tgz"`. Then run the following commands at OpenSearch Dashboards root folder:

```bash
yarn kbn bootstrap --no-validate && cd packages/kbn-ui-shared-deps/ && yarn kbn:bootstrap && cd ../../ && FORCE_DLL_CREATION=true node scripts/kibana --dev
yarn osd bootstrap --no-validate && cd packages/osd-ui-shared-deps/ && yarn osd:bootstrap && cd ../../ && FORCE_DLL_CREATION=true node scripts/osd --dev
```

* The `--no-validate` flag is required when bootstrapping with a `.tgz`.
* Change the name of the `.tgz` after subsequent `yarn build` and `npm pack` steps (e.g., `elastic-oui-xx.x.x-1.tgz`, `elastic-oui-xx.x.x-2.tgz`). This is required for `yarn` to recognize new changes to the package.
* Running `yarn kbn:bootstrap` inside of `kibana/packages/kbn-ui-shared-deps/` rebuilds Kibana's shared-ui-deps.
* Running Kibana with `FORCE_DLL_CREATION=true node scripts/kibana --dev` ensures it doesn't use a previously cached version of OUI.
* Running `yarn osd:bootstrap` inside of `OpenSearch-Dashboards/packages/osd-ui-shared-deps/` rebuilds OpenSearch Dashboards shared-ui-deps.
* Running OpenSearch Dashboards with `FORCE_DLL_CREATION=true node scripts/osd --dev` ensures it doesn't use a previously cached version of OUI.


## Principles
Expand Down

0 comments on commit 40d7d0e

Please sign in to comment.