kibana/x-pack/plugins/reporting
Tim Sullivan 8701ac85d3
Deprecate CSV job type (#89794)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-02-01 09:36:49 -07:00
..
common Deprecate CSV job type (#89794) 2021-02-01 09:36:49 -07:00
public Deprecate CSV job type (#89794) 2021-02-01 09:36:49 -07:00
server Deprecate CSV job type (#89794) 2021-02-01 09:36:49 -07:00
jest.config.js Jest multi-project configuration (#77894) 2020-12-02 11:42:23 -08:00
kibana.json [Reporting] Use spaceId from request in export generation (#76998) 2020-09-18 13:08:15 -07:00
README.md
tsconfig.json [Presentation Team] Migrate to Typescript Project References (#86019) 2021-01-31 08:37:58 -06:00

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.