mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 10:23:14 -04:00
e1ac9398d3
* Docs on docs * dev docs * Update dev_docs/contributing/documentation.mdx Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com> * Update dev_docs/contributing/documentation.mdx Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com> * Update dev_docs/contributing/documentation.mdx Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com> * Update dev_docs/contributing/documentation.mdx Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com> * Update dev_docs/contributing/documentation.mdx Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com> * Update dev_docs/contributing/documentation.mdx Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com> * Address review feedback * Update dev_docs/contributing/documentation.mdx Co-authored-by: Joe Portner <5295965+jportner@users.noreply.github.com> Co-authored-by: Daniel Mitterdorfer <danielmitterdorfer@users.noreply.github.com> Co-authored-by: Joe Portner <5295965+jportner@users.noreply.github.com>
33 lines
1.3 KiB
Text
33 lines
1.3 KiB
Text
[[development-documentation]]
|
|
== 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.
|
|
|
|
[discrete]
|
|
=== End user documentation
|
|
|
|
Documentation about user facing features should be written in http://asciidoc.org/[asciidoc] at
|
|
{kib-repo}/tree/master/docs[https://github.com/elastic/kibana/tree/main/docs]
|
|
|
|
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
|
|
```
|
|
[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 template]
|
|
* https://raw.githubusercontent.com/elastic/docs/master/shared/api-definitions-ex.asciidoc[API object definition template]
|
|
|
|
[discrete]
|
|
=== General developer documentation and guidelines
|
|
|
|
General developer guildlines and documentation, like this right here, should be written in http://asciidoc.org/[asciidoc]
|
|
at {kib-repo}/tree/master/docs/developer[https://github.com/elastic/kibana/tree/main/docs/developer]
|