Skip to content

Commit

Permalink
clean old build scripts. update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gwintzer committed Sep 14, 2018
1 parent 6f96e84 commit f4e5e12
Show file tree
Hide file tree
Showing 7 changed files with 3,593 additions and 115 deletions.
41 changes: 0 additions & 41 deletions DEVELOPER.md

This file was deleted.

43 changes: 40 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,52 @@ HTML Plugin Widget for Kibana. This Plugin was originally adapted from the Markd

![preview-edit](/resources/preview-edit.png)

# Install
## Install

```bash
bin/kibana-plugin install <PATH_OR_URL_TO_YOUR_ZIP_FILE>
```
Go to releases page for list of available packages

# Compatibility
## Compatibility
Plugins are officialy not supported, because of fast code changes even in minor Versions.

The plugin is compatible with following Versions:
* kibana (=6.1.x)
* kibana (=6.3+)

The plugin is tagged as experimental for the moment :
- Is necessary to add an option to prevent XSS injection by blocking scripts ?
- How to manage the CSS style/classes of elements like h1, h2 and others with the core CSS classes that overwriting it ?


## development

See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions setting up your development environment. Once you have completed that, use the following yarn scripts.

- `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.url http://localhost:9220
```

- `yarn build`

Build a distributable archive of your plugin.

- `yarn test:browser`

Run the browser tests in a real web browser.

- `yarn test:server`

Run the server tests using mocha.

For more information about any of these commands run `yarn ${task} --help`. For a full list of tasks checkout the `package.json` file, or run `yarn run`.
39 changes: 0 additions & 39 deletions bower.json

This file was deleted.

22 changes: 0 additions & 22 deletions build.sh

This file was deleted.

10 changes: 0 additions & 10 deletions deploy.sh

This file was deleted.

Binary file modified resources/preview-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit f4e5e12

Please sign in to comment.