mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
6517579518
# Backport This will backport the following commits from `main` to `9.0`: - [[docs] Migrate docs from AsciiDoc to Markdown (#212558)](https://github.com/elastic/kibana/pull/212558) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Colleen McGinnis","email":"colleen.mcginnis@elastic.co"},"sourceCommit":{"committedDate":"2025-03-04T13:56:07Z","message":"[docs] Migrate docs from AsciiDoc to Markdown (#212558)\n\nMigrate docs from AsciiDoc to Markdown. The preview can be built after\n#212557 is merged.\n\n@florent-leborgne please tag reviewers, add the appropriate label(s),\nand take this out of draft when you're ready.\n\nNote: More files are deleted than added here because the content from\nsome files was moved to\n[elastic/docs-content](https://github.com/elastic/docs-content).\n\n**What has moved to\n[elastic/docs-content](https://github.com/elastic/docs-content)?**\n\nPublic-facing narrative and conceptual docs have moved. Most can now be\nfound under the following directories in the new docs:\n- explore-analyze: Discover, Dashboards, Visualizations, Reporting,\nAlerting, dev tools...\n- deploy-manage: Stack management (Spaces, user management, remote\nclusters...)\n- troubleshooting: .... troubleshooting pages\n\n**What is staying in the Kibana repo?**\n\n- Reference content (= anything that is or could be auto-generated):\nSettings, syntax references\n- Release notes\n- Developer guide\n\n---------\n\nCo-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>","sha":"1814c60017da172427cd270bf2c99a8e144d378c","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","backport:version","v9.1.0"],"number":212558,"url":"https://github.com/elastic/kibana/pull/212558","mergeCommit":{"message":"[docs] Migrate docs from AsciiDoc to Markdown (#212558)\n\nMigrate docs from AsciiDoc to Markdown. The preview can be built after\n#212557 is merged.\n\n@florent-leborgne please tag reviewers, add the appropriate label(s),\nand take this out of draft when you're ready.\n\nNote: More files are deleted than added here because the content from\nsome files was moved to\n[elastic/docs-content](https://github.com/elastic/docs-content).\n\n**What has moved to\n[elastic/docs-content](https://github.com/elastic/docs-content)?**\n\nPublic-facing narrative and conceptual docs have moved. Most can now be\nfound under the following directories in the new docs:\n- explore-analyze: Discover, Dashboards, Visualizations, Reporting,\nAlerting, dev tools...\n- deploy-manage: Stack management (Spaces, user management, remote\nclusters...)\n- troubleshooting: .... troubleshooting pages\n\n**What is staying in the Kibana repo?**\n\n- Reference content (= anything that is or could be auto-generated):\nSettings, syntax references\n- Release notes\n- Developer guide\n\n---------\n\nCo-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>","sha":"1814c60017da172427cd270bf2c99a8e144d378c"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","labelRegex":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/212558","number":212558,"mergeCommit":{"message":"[docs] Migrate docs from AsciiDoc to Markdown (#212558)\n\nMigrate docs from AsciiDoc to Markdown. The preview can be built after\n#212557 is merged.\n\n@florent-leborgne please tag reviewers, add the appropriate label(s),\nand take this out of draft when you're ready.\n\nNote: More files are deleted than added here because the content from\nsome files was moved to\n[elastic/docs-content](https://github.com/elastic/docs-content).\n\n**What has moved to\n[elastic/docs-content](https://github.com/elastic/docs-content)?**\n\nPublic-facing narrative and conceptual docs have moved. Most can now be\nfound under the following directories in the new docs:\n- explore-analyze: Discover, Dashboards, Visualizations, Reporting,\nAlerting, dev tools...\n- deploy-manage: Stack management (Spaces, user management, remote\nclusters...)\n- troubleshooting: .... troubleshooting pages\n\n**What is staying in the Kibana repo?**\n\n- Reference content (= anything that is or could be auto-generated):\nSettings, syntax references\n- Release notes\n- Developer guide\n\n---------\n\nCo-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>","sha":"1814c60017da172427cd270bf2c99a8e144d378c"}}]}] BACKPORT--> Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
1.6 KiB
1.6 KiB
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 at [https://github.com/elastic/kibana/tree/main/docs(https://github.com/elastic/kibana/tree/main/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]
REST APIs should be documented using the following recommended formats:
General developer documentation and guidelines [_general_developer_documentation_and_guidelines]
General developer guildlines and documentation, like this right here, should be written in asciidoc at [https://github.com/elastic/kibana/tree/main/docs/developer(https://github.com/elastic/kibana/tree/main/docs/developer)]