History

Spencer 6cccf69451 [eslint] forbid trailing slashes in package imports (#113455 ) Co-authored-by: spalger <spalger@users.noreply.github.com>		2021-09-30 12:02:56 -05:00
..
common	[Reporting] Remove encryption logic from export types (#111472 )	2021-09-08 16:39:28 -07:00
public	[Reporting/Discover/Search Sessions] Only use relative time filter when generating share data (#112588 )	2021-09-21 12:42:32 -07:00
server	[eslint] forbid trailing slashes in package imports (#113455 )	2021-09-30 12:02:56 -05:00
jest.config.js	[jest] update config files to get coverage per plugin (#111299 )	2021-09-09 08:14:56 +02:00
kibana.json	[Reporting] Update kibana.json files with owner information (#106463 )	2021-07-22 10:03:37 +02:00
README.md
tsconfig.json	[build_ts_refs] improve caches, allow building a subset of projects (#107981 )	2021-08-10 22:12:45 -07:00

README.md

Kibana Reporting

An awesome Kibana reporting plugin

Development

Assuming you've checked out x-plugins next to kibana...

Run yarn kbn bootstrap
Run yarn start to watch for and sync files on change
Open a new terminal to run Kibana - use yarn start to launch it in dev mode
- Kibana will automatically restart as files are synced
- If you need debugging output, run DEBUG=reporting yarn start instead

If you have installed this somewhere other than via x-plugins, and next to the kibana repo, you'll need to change the pathToKibana setting in gulpfile.js

Conventions

This plugins adopts some conventions in addition to or in place of conventions in Kibana (at the time of the plugin's creation):

Folder structure

export_types/ (contains public and server aspects of the different export types) 
  printable_pdf/ 
    public/
    server/
  csv/
    public/
    server/
public/ (shared public code for all export types)
server/ (shared server code for all export types)

This folder structure treats the different export_types like Plugins, with their public/server code being separate in a folder.