[DOCS] Fixes to install and plugin docs (#45917) (#46037)

* [DOCS] Fixes to install and plugin docs

* [DOCS] Adds links to references in code
This commit is contained in:
gchaps 2019-09-18 09:26:21 -07:00 committed by GitHub
parent 7fb9d01739
commit 927204cda9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 22 additions and 15 deletions

View file

@ -1,26 +1,20 @@
[[development-plugin-resources]]
=== Plugin Resources
Here are some resources that will be helpful for getting started with plugin development
Here are some resources that are helpful for getting started with plugin development.
[float]
==== Our IRC channel
Many Kibana developers hang out on `irc.freenode.net` in the `#kibana` channel. We *want* to help you with plugin development. Even more than that, we *want your help* in understanding your plugin goals so we can build a great plugin system for you! If you've never used IRC, welcome to the fun. You can get started with the http://webchat.freenode.net/?channels=kibana[Freenode Web Client].
Many Kibana developers hang out on `irc.freenode.net` in the `#kibana` channel. We *want* to help you with plugin development. Even more than that, we *want your help* in understanding your plugin goals, so we can build a great plugin system for you! If you've never used IRC, welcome to the fun. You can get started with the http://webchat.freenode.net/?channels=kibana[Freenode Web Client].
[float]
==== Some light reading
- Our {repo}blob/master/CONTRIBUTING.md[contributing guide] can help you get a development environment going
- Tim Roes' excellent blog series https://www.timroes.de/2016/02/21/writing-kibana-plugins-custom-applications/[Writing Kibana Plugins]
[float]
==== Videos
- https://www.elastic.co/elasticon/2015/sf/contributors-guide-to-the-kibana-galaxy[Contributors Guide to the Kibana Galaxy]
- https://www.elastic.co/elasticon/conf/2016/sf/how-to-build-your-own-kibana-plugins[Kibana Plugin Dev - Elasticon 2016]
Our {repo}blob/master/CONTRIBUTING.md[contributing guide] can help you get a development environment going.
[float]
==== Plugin Generator
It is recommended that you kick-start your plugin by generating it with the {repo}tree/{branch}/packages/kbn-plugin-generator[Kibana Plugin Generator]. Run the following within the Kibana repo and you will be asked a couple questions, see some progress bars, and have a freshly generated plugin ready for you to play within Kibana's `plugins` folder.
We recommend that you kick-start your plugin by generating it with the {repo}tree/{branch}/packages/kbn-plugin-generator[Kibana Plugin Generator]. Run the following in the Kibana repo, and you will be asked a couple questions, see some progress bars, and have a freshly generated plugin ready for you to play with in Kibana's `plugins` folder.
["source","shell"]
-----------
@ -40,11 +34,11 @@ The Kibana directory must be named `kibana`, and your plugin directory should be
└── plugins
├── foo-plugin
└── bar-plugin
-----------
--------
[float]
==== References in the code
- {repo}blob/{branch}/src/server/plugins/lib/plugin.js[Plugin class]: What options does the `kibana.Plugin` class accept?
- {repo}blob/{branch}/src/legacy/server/plugins/lib/plugin.js[Plugin class]: What options does the `kibana.Plugin` class accept?
- <<development-uiexports>>: What type of exports are available?
[float]
@ -52,11 +46,12 @@ The Kibana directory must be named `kibana`, and your plugin directory should be
If you're developing a plugin that has a user interface, take a look at our https://elastic.github.io/eui[Elastic UI Framework].
It documents the CSS and React components we use to build Kibana's user interface.
You're welcome to use these components, but be aware that they are rapidly evolving and we might introduce breaking changes that will disrupt your plugin's UI.
You're welcome to use these components, but be aware that they are rapidly evolving, and we might introduce breaking changes that will disrupt your plugin's UI.
[float]
==== TypeScript Support
Plugin code can be written in http://www.typescriptlang.org/[TypeScript] if desired. To enable TypeScript support create a `tsconfig.json` file at the root of your plugin that looks something like this:
Plugin code can be written in http://www.typescriptlang.org/[TypeScript] if desired.
To enable TypeScript support, create a `tsconfig.json` file at the root of your plugin that looks something like this:
["source","js"]
-----------
@ -72,4 +67,6 @@ Plugin code can be written in http://www.typescriptlang.org/[TypeScript] if desi
}
-----------
TypeScript code is automatically converted into JavaScript during development, but not in the distributable version of Kibana. If you use the {repo}blob/{branch}/packages/kbn-plugin-helpers[@kbn/plugin-helpers] to build your plugin then your `.ts` and `.tsx` files will be permanently transpiled before your plugin is archived. If you have your own build process, make sure to run the TypeScript compiler on your source files and ship the compilation output so that your plugin will work with the distributable version of Kibana.
TypeScript code is automatically converted into JavaScript during development,
but not in the distributable version of Kibana. If you use the
{repo}blob/{branch}/packages/kbn-plugin-helpers[@kbn/plugin-helpers] to build your plugin, then your `.ts` and `.tsx` files will be permanently transpiled before your plugin is archived. If you have your own build process, make sure to run the TypeScript compiler on your source files and ship the compilation output so that your plugin will work with the distributable version of Kibana.

View file

@ -205,6 +205,11 @@ locations for a Debian-based system:
| The location of the data files written to disk by Kibana and its plugins
| /var/lib/kibana
| path.data
| logs
| Logs files location
| /var/log/kibana
| path.logs
| optimize
| Transpiled source code. Certain administrative actions (e.g. plugin install)

View file

@ -196,6 +196,11 @@ locations for an RPM-based system:
| The location of the data files written to disk by Kibana and its plugins
| /var/lib/kibana
| path.data
| logs
| Logs files location
| /var/log/kibana
| path.logs
| optimize
| Transpiled source code. Certain administrative actions (e.g. plugin install)