IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Documentation during development
editDocumentation during development
editDocs should be written during development and accompany PRs when relevant. There are multiple types of documentation, and different places to add each.
Developer services documentation
editDocumentation about specific services a plugin offers should be encapsulated in:
- README.asciidoc at the base of the plugin folder.
- Typescript comments for all public services.
End user documentation
editDocumentation about user facing features should be written in asciidoc at https://github.com/elastic/kibana/tree/master/docs
To build the docs, you must clone the elastic/docs repo as a sibling of your Kibana repo. Follow the instructions in that project’s README for getting the docs tooling set up.
To build the docs:
node scripts/docs.js --open
General developer documentation and guidelines
editGeneral developer guildlines and documentation, like this right here, should be written in asciidoc at https://github.com/elastic/kibana/tree/master/docs/developer