2020-07-13 16:47:01 +02:00
[[development-documentation]]
2020-07-16 16:13:51 +02:00
== Documentation during development
2020-07-13 16:47:01 +02:00
Docs should be written during development and accompany PRs when relevant. There are multiple types of documentation, and different places to add each.
2020-07-16 16:13:51 +02:00
[discrete]
=== Developer services documentation
2020-07-13 16:47:01 +02:00
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.
2020-07-16 16:13:51 +02:00
[discrete]
=== End user documentation
2020-07-13 16:47:01 +02:00
Documentation about user facing features should be written in http://asciidoc.org/[asciidoc] at
2021-10-29 19:07:44 +02:00
{kib-repo}/tree/master/docs[https://github.com/elastic/kibana/tree/main/docs]
2020-07-13 16:47:01 +02:00
To build the docs, you must clone the https://github.com/elastic/docs[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:**
```bash
node scripts/docs.js --open
```
2020-10-08 21:11:49 +02:00
[discrete]
==== REST APIs
REST APIs should be documented using the following recommended formats:
* https://raw.githubusercontent.com/elastic/docs/master/shared/api-ref-ex.asciidoc[API doc templaate]
* https://raw.githubusercontent.com/elastic/docs/master/shared/api-definitions-ex.asciidoc[API object definition template]
2020-07-13 16:47:01 +02:00
2020-07-16 16:13:51 +02:00
[discrete]
=== General developer documentation and guidelines
2020-07-13 16:47:01 +02:00
General developer guildlines and documentation, like this right here, should be written in http://asciidoc.org/[asciidoc]
2021-10-29 19:07:44 +02:00
at {kib-repo}/tree/master/docs/developer[https://github.com/elastic/kibana/tree/main/docs/developer]