Skip to content

[docs] Fix various syntax and rendering errors #17580

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 elastic/docs-content#1183

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)
  • 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)

Copy link

mergify bot commented Apr 22, 2025

This pull request does not have a backport label. Could you fix it @colleenmcginnis? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit.
  • If no backport is necessary, please add the backport-skip label

@colleenmcginnis colleenmcginnis marked this pull request as ready for review April 23, 2025 20:14
@colleenmcginnis colleenmcginnis added the backport-9.0 Automated backport to the 9.0 branch with mergify label Apr 23, 2025
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

@colleenmcginnis colleenmcginnis merged commit 54472f2 into elastic:main Apr 23, 2025
8 checks passed
@colleenmcginnis colleenmcginnis deleted the fix-syntax-rendering-errors branch April 23, 2025 20:19
mergify bot pushed a commit that referenced this pull request Apr 23, 2025
* fix various syntax and rendering issues

* more fixes

(cherry picked from commit 54472f2)
@karenzone
Copy link
Contributor

Please allow me more than five minutes to review before merging, please? 😄

karenzone pushed a commit that referenced this pull request Apr 29, 2025
Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-9.0 Automated backport to the 9.0 branch with mergify docs Team:Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Issue]: Unprocessed keywords in docs pages
3 participants