History

Tim Sullivan ef0fba1bd2 [Reporting] Copy Post URL: track layoutID in state (#30029 ) * [Reporting] Post URL: track layoutID in state * I think this code was not supposed to be here * ts fix * revert some diff * Revert "I think this code was not supposed to be here" This reverts commit `b2e5f60afb`. * static getAbsoluteReportGenerationUrl * ts fix		2019-02-05 13:48:44 -07:00
..
common	Adding in browser info to the report-info drawer (#26307 )	2018-12-04 12:08:24 -08:00
export_types	Dashboard design updates (#29896 )	2019-02-05 13:42:37 -05:00
public	[Reporting] Copy Post URL: track layoutID in state (#30029 )	2019-02-05 13:48:44 -07:00
server	Remove dependency on doc versions (#29906 )	2019-02-04 21:13:34 -08:00
test_helpers	Combine common pdf png functions (#25152 )	2018-11-14 08:28:07 -05:00
index.js	Quick smoke test of chromium on startup for diagnosing (#28001 )	2019-01-09 08:07:57 -08:00
log_configuration.js	Testing x pack jest integration (#26825 )	2019-01-10 14:31:12 -05:00
README.md
types.d.ts	Initialize authorization mode for reporting jobs (#26762 )	2018-12-10 16:56:43 -05: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.