Skip to content

[docs] Fix various syntax and rendering errors #2940

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Merged
merged 2 commits into from
Apr 28, 2025
Merged

[docs] Fix various syntax and rendering errors #2940

merged 2 commits into from
Apr 28, 2025

Conversation

colleenmcginnis
Copy link
Contributor

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

@colleenmcginnis colleenmcginnis self-assigned this Apr 21, 2025
@colleenmcginnis colleenmcginnis marked this pull request as ready for review April 24, 2025 17:21
@colleenmcginnis colleenmcginnis enabled auto-merge (squash) April 24, 2025 17:21
pquentin
pquentin approved these changes Apr 28, 2025
View reviewed changes
Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM.

@colleenmcginnis colleenmcginnis merged commit 631956d into elastic:main Apr 28, 2025
15 checks passed
github-actions bot pushed a commit that referenced this pull request Apr 28, 2025
@colleenmcginnis @github-actions
[docs] Fix various syntax and rendering errors (#2940)
cd0fa1f 
* fix various syntax and rendering issues

* fix image

(cherry picked from commit 631956d)
@github-actions github-actions bot mentioned this pull request Apr 28, 2025
Merged
pquentin pushed a commit that referenced this pull request Apr 28, 2025
@github-actions @colleenmcginnis
[docs] Fix various syntax and rendering errors (#2940) (#2944)
022beb4 
* fix various syntax and rendering issues

* fix image

(cherry picked from commit 631956d)

Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
@colleenmcginnis colleenmcginnis deleted the fix-syntax-rendering-errors branch May 7, 2025 23:03
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@pquentin pquentin pquentin approved these changes

@marciw marciw Awaiting requested review from marciw

Assignees

@colleenmcginnis colleenmcginnis

Labels
Area: Documentation backport 9.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@colleenmcginnis @pquentin