Skip to content

[Plugin generator] Update readme #81131

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
merged 1 commit into from
Oct 25, 2020
Merged

[Plugin generator] Update readme #81131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 12 additions & 9 deletions packages/kbn-plugin-generator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,22 +51,14 @@ yarn kbn bootstrap

Generated plugins receive a handful of scripts that can be used during development. Those scripts are detailed in the [README.md](template/README.md) file in each newly generated plugin, and expose the scripts provided by the [Kibana plugin helpers](../kbn-plugin-helpers), but here is a quick reference in case you need it:

> ***NOTE:*** All of these scripts should be run from the generated plugin.
> ***NOTE:*** The following scripts should be run from the generated plugin.

- `yarn kbn bootstrap`

Install dependencies and crosslink Kibana and all projects/plugins.

> ***IMPORTANT:*** Use this script instead of `yarn` to install dependencies when switching branches, and re-run it whenever your dependencies change.

- `yarn start`

Start kibana and have it include this plugin. You can pass any arguments that you would normally send to `bin/kibana`

```
yarn start --elasticsearch.hosts http://localhost:9220
```

- `yarn build`

Build a distributable archive of your plugin.
Expand All @@ -75,4 +67,15 @@ Generated plugins receive a handful of scripts that can be used during developme

Run the server tests using mocha.


To start kibana run the following command from Kibana root.

- `yarn start`

Start kibana and it will automatically include this plugin. You can pass any arguments that you would normally send to `bin/kibana`

```
yarn start --elasticsearch.hosts http://localhost:9220
```

For more information about any of these commands run `yarn ${task} --help`. For a full list of tasks run `yarn run` or take a look in the `package.json` file.