Skip to content

[docs] Fix various syntax and rendering errors #218883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Apr 22, 2025

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 Add support for *-version attributes in the docs docs-builder#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

@colleenmcginnis colleenmcginnis added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 v9.1.0 v9.0.1 labels Apr 24, 2025
@colleenmcginnis colleenmcginnis marked this pull request as ready for review April 24, 2025 17:56
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner April 24, 2025 17:56
@colleenmcginnis colleenmcginnis requested a review from xcrzx April 24, 2025 17:56
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

cc @colleenmcginnis

@colleenmcginnis colleenmcginnis requested review from a team and removed request for a team and xcrzx April 24, 2025 18:13
Copy link
Contributor

@wajihaparvez wajihaparvez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much, Colleen! LGTM 👏 I just found two very minor nits

@wajihaparvez wajihaparvez added the backport:version Backport to applied version labels label Apr 25, 2025
@florent-leborgne florent-leborgne merged commit fbda17d into elastic:main May 22, 2025
10 checks passed
@colleenmcginnis colleenmcginnis deleted the fix-syntax-rendering-errors branch May 22, 2025 14:15
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label May 23, 2025
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 218883 locally
cc: @colleenmcginnis

@florent-leborgne
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
9.0

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/kibana that referenced this pull request May 26, 2025
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
elastic/docs-builder#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>
(cherry picked from commit fbda17d)
florent-leborgne added a commit that referenced this pull request May 26, 2025
# Backport

This will backport the following commits from `main` to `9.0`:
- [[docs] Fix various syntax and rendering errors
(#218883)](#218883)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Colleen
McGinnis","email":"colleen.mcginnis@elastic.co"},"sourceCommit":{"committedDate":"2025-05-22T08:10:07Z","message":"[docs]
Fix various syntax and rendering errors (#218883)\n\nFixes various
syntax and rendering errors that might include:\n\n* Fixing broken
images\n* Hardcoding book-level substitution values\n* Fixing
incorrectly closed blocks (admonitions, tab sets, code
blocks,\ndropdowns etc.)\n* Fixing poorly migrated complex tables\n*
Fixing poorly migrated lists\n* Fixing poorly migrated tab sets\n*
Removing inline text formatting from directive titles where they
won't\nbe rendered (for example, inline `code` formatting in dropdown
titles)\n* Specifying if a version is trying to communicate if a feature
was\nadded, deprecated, or coming (for example, during
migration\n`deprecated:[8.15.0]` became `[8.15.0]`, which doesn't give
any\ninformation about _what_ happened in 8.15.0)\n* Note: I used an
`{admonition}` for this, but you can change it to\nprose or some other
kind of admonition if you want.\n* Fixing nested dropdowns / definition
lists\n* Fixing poorly migrated footnotes\n* Updating references to
prerelease `9.0.0` versions (using a repo-level\nsubstitution until
there is a solution
to\nhttps://github.com/elastic/docs-builder/issues/737)\n\nLinks to
pages that were updated:\n\n| Before | After |\n|---|---|\n|
https://www.elastic.co/docs/extend/kibana/development-documentation
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/development-documentation\n|\n|
https://www.elastic.co/docs/extend/kibana/development-security
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/development-security\n|\n|
https://www.elastic.co/docs/extend/kibana/development-tests
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/development-tests\n|\n|\nhttps://www.elastic.co/docs/extend/kibana/external-plugin-functional-tests\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-functional-tests\n|\n|
https://www.elastic.co/docs/extend/kibana/external-plugin-localization\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-localization\n|\n|
https://www.elastic.co/docs/extend/kibana/interpreting-ci-failures
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/interpreting-ci-failures\n|\n|
https://www.elastic.co/docs/extend/kibana/plugin-list
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/plugin-list\n|\n|
https://www.elastic.co/docs/extend/kibana/sample-data
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/sample-data\n|\n|
https://www.elastic.co/docs/extend/kibana/saved-objects-service
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/saved-objects-service\n|\n|
https://www.elastic.co/docs/extend/kibana/sharing-saved-objects
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/sharing-saved-objects\n|\n|
https://www.elastic.co/docs/extend/kibana/stability
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/stability\n|\n|
https://www.elastic.co/docs/reference/kibana/advanced-settings
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/reference/advanced-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/ai-assistant-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/ai-assistant-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/fleet-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/fleet-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/general-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/general-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/monitoring-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/monitoring-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/reporting-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/reporting-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/task-manager-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/task-manager-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/cases-webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/cases-webhook-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/email-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/email-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/pre-configured-connectors\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/pre-configured-connectors\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-itom-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-itom-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-sir-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-sir-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/thehive-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/thehive-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/webhook-action-type\n|\n|
https://www.elastic.co/docs/reference/kibana/kibana-audit-events
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/reference/kibana-audit-events\n|\n|
https://www.elastic.co/docs/reference/kibana/kibana-plugins
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/reference/kibana-plugins\n|\n|
https://www.elastic.co/docs/release-kibana/notes/index
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/release-notes/index\n|\n\n---------\n\nCo-authored-by:
wajihaparvez
<wajiha.parvez@elastic.co>","sha":"fbda17de2dbcf4289b1c269bdec0cb1d626bc7ad","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","backport
missing","docs","documentation","backport:version","v9.1.0","v9.0.2"],"title":"[docs]
Fix various syntax and rendering
errors","number":218883,"url":"https://github.com/elastic/kibana/pull/218883","mergeCommit":{"message":"[docs]
Fix various syntax and rendering errors (#218883)\n\nFixes various
syntax and rendering errors that might include:\n\n* Fixing broken
images\n* Hardcoding book-level substitution values\n* Fixing
incorrectly closed blocks (admonitions, tab sets, code
blocks,\ndropdowns etc.)\n* Fixing poorly migrated complex tables\n*
Fixing poorly migrated lists\n* Fixing poorly migrated tab sets\n*
Removing inline text formatting from directive titles where they
won't\nbe rendered (for example, inline `code` formatting in dropdown
titles)\n* Specifying if a version is trying to communicate if a feature
was\nadded, deprecated, or coming (for example, during
migration\n`deprecated:[8.15.0]` became `[8.15.0]`, which doesn't give
any\ninformation about _what_ happened in 8.15.0)\n* Note: I used an
`{admonition}` for this, but you can change it to\nprose or some other
kind of admonition if you want.\n* Fixing nested dropdowns / definition
lists\n* Fixing poorly migrated footnotes\n* Updating references to
prerelease `9.0.0` versions (using a repo-level\nsubstitution until
there is a solution
to\nhttps://github.com/elastic/docs-builder/issues/737)\n\nLinks to
pages that were updated:\n\n| Before | After |\n|---|---|\n|
https://www.elastic.co/docs/extend/kibana/development-documentation
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/development-documentation\n|\n|
https://www.elastic.co/docs/extend/kibana/development-security
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/development-security\n|\n|
https://www.elastic.co/docs/extend/kibana/development-tests
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/development-tests\n|\n|\nhttps://www.elastic.co/docs/extend/kibana/external-plugin-functional-tests\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-functional-tests\n|\n|
https://www.elastic.co/docs/extend/kibana/external-plugin-localization\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-localization\n|\n|
https://www.elastic.co/docs/extend/kibana/interpreting-ci-failures
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/interpreting-ci-failures\n|\n|
https://www.elastic.co/docs/extend/kibana/plugin-list
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/plugin-list\n|\n|
https://www.elastic.co/docs/extend/kibana/sample-data
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/sample-data\n|\n|
https://www.elastic.co/docs/extend/kibana/saved-objects-service
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/saved-objects-service\n|\n|
https://www.elastic.co/docs/extend/kibana/sharing-saved-objects
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/sharing-saved-objects\n|\n|
https://www.elastic.co/docs/extend/kibana/stability
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/stability\n|\n|
https://www.elastic.co/docs/reference/kibana/advanced-settings
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/reference/advanced-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/ai-assistant-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/ai-assistant-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/fleet-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/fleet-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/general-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/general-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/monitoring-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/monitoring-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/reporting-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/reporting-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/task-manager-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/task-manager-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/cases-webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/cases-webhook-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/email-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/email-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/pre-configured-connectors\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/pre-configured-connectors\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-itom-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-itom-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-sir-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-sir-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/thehive-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/thehive-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/webhook-action-type\n|\n|
https://www.elastic.co/docs/reference/kibana/kibana-audit-events
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/reference/kibana-audit-events\n|\n|
https://www.elastic.co/docs/reference/kibana/kibana-plugins
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/reference/kibana-plugins\n|\n|
https://www.elastic.co/docs/release-kibana/notes/index
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/release-notes/index\n|\n\n---------\n\nCo-authored-by:
wajihaparvez
<wajiha.parvez@elastic.co>","sha":"fbda17de2dbcf4289b1c269bdec0cb1d626bc7ad"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/218883","number":218883,"mergeCommit":{"message":"[docs]
Fix various syntax and rendering errors (#218883)\n\nFixes various
syntax and rendering errors that might include:\n\n* Fixing broken
images\n* Hardcoding book-level substitution values\n* Fixing
incorrectly closed blocks (admonitions, tab sets, code
blocks,\ndropdowns etc.)\n* Fixing poorly migrated complex tables\n*
Fixing poorly migrated lists\n* Fixing poorly migrated tab sets\n*
Removing inline text formatting from directive titles where they
won't\nbe rendered (for example, inline `code` formatting in dropdown
titles)\n* Specifying if a version is trying to communicate if a feature
was\nadded, deprecated, or coming (for example, during
migration\n`deprecated:[8.15.0]` became `[8.15.0]`, which doesn't give
any\ninformation about _what_ happened in 8.15.0)\n* Note: I used an
`{admonition}` for this, but you can change it to\nprose or some other
kind of admonition if you want.\n* Fixing nested dropdowns / definition
lists\n* Fixing poorly migrated footnotes\n* Updating references to
prerelease `9.0.0` versions (using a repo-level\nsubstitution until
there is a solution
to\nhttps://github.com/elastic/docs-builder/issues/737)\n\nLinks to
pages that were updated:\n\n| Before | After |\n|---|---|\n|
https://www.elastic.co/docs/extend/kibana/development-documentation
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/development-documentation\n|\n|
https://www.elastic.co/docs/extend/kibana/development-security
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/development-security\n|\n|
https://www.elastic.co/docs/extend/kibana/development-tests
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/development-tests\n|\n|\nhttps://www.elastic.co/docs/extend/kibana/external-plugin-functional-tests\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-functional-tests\n|\n|
https://www.elastic.co/docs/extend/kibana/external-plugin-localization\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-localization\n|\n|
https://www.elastic.co/docs/extend/kibana/interpreting-ci-failures
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/interpreting-ci-failures\n|\n|
https://www.elastic.co/docs/extend/kibana/plugin-list
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/plugin-list\n|\n|
https://www.elastic.co/docs/extend/kibana/sample-data
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/sample-data\n|\n|
https://www.elastic.co/docs/extend/kibana/saved-objects-service
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/saved-objects-service\n|\n|
https://www.elastic.co/docs/extend/kibana/sharing-saved-objects
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/sharing-saved-objects\n|\n|
https://www.elastic.co/docs/extend/kibana/stability
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/extend/stability\n|\n|
https://www.elastic.co/docs/reference/kibana/advanced-settings
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/reference/advanced-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/ai-assistant-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/ai-assistant-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/fleet-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/fleet-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/general-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/general-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/monitoring-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/monitoring-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/reporting-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/reporting-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/task-manager-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/task-manager-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/cases-webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/cases-webhook-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/email-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/email-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/pre-configured-connectors\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/pre-configured-connectors\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-itom-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-itom-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-sir-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-sir-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/thehive-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/thehive-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/webhook-action-type\n|\n|
https://www.elastic.co/docs/reference/kibana/kibana-audit-events
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/reference/kibana-audit-events\n|\n|
https://www.elastic.co/docs/reference/kibana/kibana-plugins
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/reference/kibana-plugins\n|\n|
https://www.elastic.co/docs/release-kibana/notes/index
|\nhttps://docs-v3-preview.elastic.dev//pull/218883/release-notes/index\n|\n\n---------\n\nCo-authored-by:
wajihaparvez
<wajiha.parvez@elastic.co>","sha":"fbda17de2dbcf4289b1c269bdec0cb1d626bc7ad"}},{"branch":"9.0","label":"v9.0.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
Co-authored-by: wajihaparvez <wajiha.parvez@elastic.co>
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label May 26, 2025
akowalska622 pushed a commit to akowalska622/kibana that referenced this pull request May 29, 2025
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
elastic/docs-builder#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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels docs documentation release_note:skip Skip the PR/issue when compiling release notes Team:Docs v9.0.2 v9.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants