github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 09:48:58 -04:00
Code Issues Projects Releases Packages Wiki Activity

[7.x] [Plugin generator] Update readme (#81131) (#81578)

Browse source
This commit is contained in:
Ahmad Bamieh 2020-10-25 16:38:50 +03:00 • committed by GitHub
parent 485b4c4791
commit 27163f7b99
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

21
packages/kbn-plugin-generator/README.md
View file

@ -51,7 +51,7 @@ 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`
@ -59,14 +59,6 @@ Generated plugins receive a handful of scripts that can be used during developme
> ***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.
@ -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.