History

Joel Griffith 932e92b8ad Make sure `to` is 'now' and not the same as `from` (#81524 ) * Make sure `to` is 'now' and not the same as `from` * Revert "Make sure `to` is 'now' and not the same as `from`" This reverts commit `48e8d08213`. * Ensure `to` is properly rounded up to prevent `from` and `to` being identical Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>		2020-10-26 15:24:29 -07:00
..
common	[Reporting] Clean Up TypeScript Definitions (#76566 )	2020-09-22 12:33:59 -07:00
public	Make sure `to` is 'now' and not the same as `from` (#81524 )	2020-10-26 15:24:29 -07:00
server	[Reporting/Tech Debt] Convert PdfMaker class to TypeScript (#81242 )	2020-10-21 13:54:52 -07:00
constants.ts
kibana.json	[Reporting] Use spaceId from request in export generation (#76998 )	2020-09-18 13:08:15 -07:00
README.md

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.