mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 19:13:14 -04:00
Fixes various syntax and rendering errors that might include: * Fixing broken images * Hardcoding book-level substitution values * Fixing incorrectly closed blocks (admonitions, tab sets, code blocks, dropdowns etc.) * Fixing poorly migrated complex tables * Fixing poorly migrated lists * Fixing poorly migrated tab sets * Removing inline text formatting from directive titles where they won't be rendered (for example, inline `code` formatting in dropdown titles) * Specifying if a version is trying to communicate if a feature was added, deprecated, or coming (for example, during migration `deprecated:[8.15.0]` became `[8.15.0]`, which doesn't give any information about _what_ happened in 8.15.0) * Note: I used an `{admonition}` for this, but you can change it to prose or some other kind of admonition if you want. * Fixing nested dropdowns / definition lists * Fixing poorly migrated footnotes * Updating references to prerelease `9.0.0` versions (using a repo-level substitution until there is a solution to https://github.com/elastic/docs-builder/issues/737) Links to pages that were updated: | Before | After | |---|---| | https://www.elastic.co/docs/extend/kibana/development-documentation | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-documentation | | https://www.elastic.co/docs/extend/kibana/development-security | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-security | | https://www.elastic.co/docs/extend/kibana/development-tests | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-tests | | https://www.elastic.co/docs/extend/kibana/external-plugin-functional-tests | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-functional-tests | | https://www.elastic.co/docs/extend/kibana/external-plugin-localization | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-localization | | https://www.elastic.co/docs/extend/kibana/interpreting-ci-failures | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/interpreting-ci-failures | | https://www.elastic.co/docs/extend/kibana/plugin-list | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/plugin-list | | https://www.elastic.co/docs/extend/kibana/sample-data | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/sample-data | | https://www.elastic.co/docs/extend/kibana/saved-objects-service | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/saved-objects-service | | https://www.elastic.co/docs/extend/kibana/sharing-saved-objects | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/sharing-saved-objects | | https://www.elastic.co/docs/extend/kibana/stability | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/stability | | https://www.elastic.co/docs/reference/kibana/advanced-settings | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/advanced-settings | | https://www.elastic.co/docs/reference/kibana/configuration-reference/ai-assistant-settings | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/ai-assistant-settings | | https://www.elastic.co/docs/reference/kibana/configuration-reference/fleet-settings | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/fleet-settings | | https://www.elastic.co/docs/reference/kibana/configuration-reference/general-settings | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/general-settings | | https://www.elastic.co/docs/reference/kibana/configuration-reference/monitoring-settings | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/monitoring-settings | | https://www.elastic.co/docs/reference/kibana/configuration-reference/reporting-settings | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/reporting-settings | | https://www.elastic.co/docs/reference/kibana/configuration-reference/task-manager-settings | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/task-manager-settings | | https://www.elastic.co/docs/reference/kibana/connectors-kibana/cases-webhook-action-type | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/cases-webhook-action-type | | https://www.elastic.co/docs/reference/kibana/connectors-kibana/email-action-type | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/email-action-type | | https://www.elastic.co/docs/reference/kibana/connectors-kibana/pre-configured-connectors | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/pre-configured-connectors | | https://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-action-type | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-action-type | | https://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-itom-action-type | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-itom-action-type | | https://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-sir-action-type | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-sir-action-type | | https://www.elastic.co/docs/reference/kibana/connectors-kibana/thehive-action-type | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/thehive-action-type | | https://www.elastic.co/docs/reference/kibana/connectors-kibana/webhook-action-type | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/webhook-action-type | | https://www.elastic.co/docs/reference/kibana/kibana-audit-events | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/kibana-audit-events | | https://www.elastic.co/docs/reference/kibana/kibana-plugins | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/kibana-plugins | | https://www.elastic.co/docs/release-kibana/notes/index | https://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/release-notes/index | --------- Co-authored-by: wajihaparvez <wajiha.parvez@elastic.co>
1.5 KiB
1.5 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.
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/extend.