Skip to content

Update docs on how to test local EUI in Kibana #2144

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

Merged
snide merged 5 commits into from
Jul 19, 2019
Merged

Update docs on how to test local EUI in Kibana #2144

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
72a9b5b
Update docs on how to test local EUI in Kibana
snide Jul 19, 2019
f686ec5
typo
snide Jul 19, 2019
ccbee81
Update wiki/component-development.md
snide Jul 19, 2019
93cdd06
Update wiki/component-development.md
snide Jul 19, 2019
4aadfc5
adjustments
snide Jul 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions wiki/component-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ Refer to the [testing guide](testing.md) for guidelines on writing and designing

### Testing the component with Kibana

1. In the `eui` folder, run `yarn link` to create the `@elastic/eui` link package.
Note that `yarn link` currently does not work with Kibana. You'll need to manually pack and insert it into Kibana to test locally.

2. In the `kibana` folder (and potentially the `x-pack` sub-folder as well, if you are working in x-pack code), run `yarn link @elastic/eui` to install the link package you just created.

3. Start up the Kibana server.

4. Back in the `eui` folder, run `yarn build`. Repeat (just) this step any time you make changes to your EUI component.
1. In the `eui` folder, run `npm pack`. This will create a `.tgz` file in your EUI directory. At this point you can move it anywhere.
2. In Kibana you have two choices:
* Point your `package.json` files in Kibana to that file: `"@elastic/eui": "/path/to/elastic-eui-xx.x.x.tgz"` and run `yarn kbn bootstrap`.
* Alternatively (and often easier), you can run `yarn kbn bootstrap` in Kibana first, then just unpack the `.tgz` file and paste its contents into an empty `/kibana/node_modules/@elastic/eui` folder. This method avoids having to edit all the various `package.json` files in Kibana if you need to run functional tests.
3. Regardless of the method you decide run Kibana with `FORCE_DLL_CREATION=true node scripts/kibana --dev` to make sure it doesn't use a previously cached version of EUI.

## Principles

Expand Down