mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
fe908bae95
Signed-off-by: Tyler Smalley <tyler.smalley@elastic.co> # Conflicts: # .github/ISSUE_TEMPLATE/v8_breaking_change.md # .github/PULL_REQUEST_TEMPLATE.md # dev_docs/contributing/best_practices.mdx # dev_docs/key_concepts/anatomy_of_a_plugin.mdx # docs/developer/contributing/interpreting-ci-failures.asciidoc # examples/routing_example/public/app.tsx # legacy_rfcs/text/0005_route_handler.md # legacy_rfcs/text/0006_management_section_service.md # legacy_rfcs/text/0015_bazel.md # packages/kbn-spec-to-console/README.md # src/dev/code_coverage/docs/team_assignment/README.md # src/plugins/embeddable/README.asciidoc
41 lines
1.5 KiB
Text
41 lines
1.5 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]
|
|
=== 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.
|
|
|
|
[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 templaate]
|
|
* 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]
|