Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.52 KB

development-documentation.asciidoc

File metadata and controls

41 lines (28 loc) · 1.52 KB

Documentation during development

Docs 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

Documentation 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

Documentation about user facing features should be written in asciidoc at {kib-repo}/tree/master/docs[https://github.com/elastic/kibana/tree/master/docs]

To build the docs, you must clone the elastic/docs repo as a sibling of your {kib} 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

REST APIs

REST APIs should be documented using the following recommended formats:

General developer documentation and guidelines

General developer guildlines and documentation, like this right here, should be written in asciidoc at {kib-repo}/tree/master/docs/developer[https://github.com/elastic/kibana/tree/master/docs/developer]