structure.md

Kibana directory structure

Example:

dev
    bin
    config
    data
    logs
    optimize
dist
    build
    artifacts
docs
    api
    developer
    reference
    ui_framework
node_modules
src
    cli
    core
        client
            api
            application
            background_task
            http
            interface
            notification
            plugin
            router
            settings
            storage
            translation
        server
            asset
            background_task
            client
            elasticsearch
            http
            plugin
            rest
            settings
            translation
    packages
        utils
    plugins
        dashboard
        discover
        embed
        management
        maps
        markdown
        metrics
        querybar
        sharing
        timelion
        timepicker
        visualize
    ui_framework
tests
    api
    client
    smoke
    upgrade
tools
    build
    dev
    docs
    test

dev

Files for the local dev environment. This directory will look similar to a built version of Kibana, though its contents will mostly be created and managed automatically from dev tools.

You can put things like developer config in here as it will be ignored.

dist

Distribution artifacts for builds. This directory is ephemeral and would be completely ignored.

docs

All of our documentation, broken down based on purpose. The reference docs are what we have now in asciidoc, and the ui_framework docs would just include any documentation-specific code/information since the UI framework itself is driven by the source code.

api and developer docs are new, but we should have these things.

node_modules

One package.json to rule them all.

src

All source code that we've written that powers production builds goes here. You can reliably grep this directory for release source code.

tests

All of our functional tests, broken down by purpose.

• api Tests for our REST API
• client Standlone selenium tests that can be run on any Kibana install
• smoke Tests for deployment scenarios and basic availability of a Kibana install
• upgrade Tests for upgrade scenarios. Will probably trigger smoke and client tests.

tools

Various CLI tools for developing and testing Kibana.