mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
1814c60017
Migrate docs from AsciiDoc to Markdown. The preview can be built after #212557 is merged. @florent-leborgne please tag reviewers, add the appropriate label(s), and take this out of draft when you're ready. Note: More files are deleted than added here because the content from some files was moved to [elastic/docs-content](https://github.com/elastic/docs-content). **What has moved to [elastic/docs-content](https://github.com/elastic/docs-content)?** Public-facing narrative and conceptual docs have moved. Most can now be found under the following directories in the new docs: - explore-analyze: Discover, Dashboards, Visualizations, Reporting, Alerting, dev tools... - deploy-manage: Stack management (Spaces, user management, remote clusters...) - troubleshooting: .... troubleshooting pages **What is staying in the Kibana repo?** - Reference content (= anything that is or could be auto-generated): Settings, syntax references - Release notes - Developer guide --------- Co-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>
34 lines
1.6 KiB
Markdown
34 lines
1.6 KiB
Markdown
---
|
||
mapped_pages:
|
||
- https://www.elastic.co/guide/en/kibana/current/development-documentation.html
|
||
---
|
||
|
||
# Documentation during development [development-documentation]
|
||
|
||
Docs should be written during development and accompany PRs when relevant. There are multiple types of documentation, and different places to add each.
|
||
|
||
|
||
## End user documentation [_end_user_documentation]
|
||
|
||
Documentation about user facing features should be written in [asciidoc](http://asciidoc.org/) at [[https://github.com/elastic/kibana/tree/main/docs](https://github.com/elastic/kibana//tree/master/docs)(https://github.com/elastic/kibana/tree/main/docs)]
|
||
|
||
To build the docs, you must clone the [elastic/docs](https://github.com/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
|
||
```
|
||
|
||
|
||
### REST APIs [_rest_apis]
|
||
|
||
REST APIs should be documented using the following recommended formats:
|
||
|
||
* [API doc template](https://raw.githubusercontent.com/elastic/docs/master/shared/api-ref-ex.asciidoc)
|
||
* [API object definition template](https://raw.githubusercontent.com/elastic/docs/master/shared/api-definitions-ex.asciidoc)
|
||
|
||
|
||
## General developer documentation and guidelines [_general_developer_documentation_and_guidelines]
|
||
|
||
General developer guildlines and documentation, like this right here, should be written in [asciidoc](http://asciidoc.org/) at [[https://github.com/elastic/kibana/tree/main/docs/developer](https://github.com/elastic/kibana//tree/master/docs/developer)(https://github.com/elastic/kibana/tree/main/docs/developer)]
|