Skip to content

Commit 82ba41c

Browse files
authored
[Plugin generator] Update readme (#81131)
1 parent 26cfda6 commit 82ba41c

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

packages/kbn-plugin-generator/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,22 +51,14 @@ yarn kbn bootstrap
5151

5252
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:
5353

54-
> ***NOTE:*** All of these scripts should be run from the generated plugin.
54+
> ***NOTE:*** The following scripts should be run from the generated plugin.
5555
5656
- `yarn kbn bootstrap`
5757

5858
Install dependencies and crosslink Kibana and all projects/plugins.
5959

6060
> ***IMPORTANT:*** Use this script instead of `yarn` to install dependencies when switching branches, and re-run it whenever your dependencies change.
6161
62-
- `yarn start`
63-
64-
Start kibana and have it include this plugin. You can pass any arguments that you would normally send to `bin/kibana`
65-
66-
```
67-
yarn start --elasticsearch.hosts http://localhost:9220
68-
```
69-
7062
- `yarn build`
7163

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

7668
Run the server tests using mocha.
7769

70+
71+
To start kibana run the following command from Kibana root.
72+
73+
- `yarn start`
74+
75+
Start kibana and it will automatically include this plugin. You can pass any arguments that you would normally send to `bin/kibana`
76+
77+
```
78+
yarn start --elasticsearch.hosts http://localhost:9220
79+
```
80+
7881
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.

0 commit comments

Comments
 (0)