Skip to content

[docs] Fix various syntax and rendering errors #44038

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Apr 24, 2025
Merged

[docs] Fix various syntax and rendering errors #44038

merged 9 commits into from
Apr 24, 2025

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Apr 23, 2025 •
edited
Loading

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)

It also adds chunks of missing content in the quickstarts. It looks like there was a problem migrating that content over and some of the middle steps were lost.

📝 Expand list of links to changed pages

@colleenmcginnis colleenmcginnis added docs Team:Docs Label for the Observability docs team labels Apr 23, 2025
@colleenmcginnis colleenmcginnis self-assigned this Apr 23, 2025
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Apr 23, 2025
@mergify Mergify
Copy link
Contributor

mergify bot commented Apr 23, 2025

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @colleenmcginnis? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

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
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

@colleenmcginnis colleenmcginnis marked this pull request as ready for review April 24, 2025 15:20
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner April 24, 2025 15:20
karenzone
karenzone approved these changes Apr 24, 2025
View reviewed changes
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

So many improvements. Thank you! LGTM

@colleenmcginnis colleenmcginnis merged commit 940caef into elastic:main Apr 24, 2025
10 of 11 checks passed
@colleenmcginnis colleenmcginnis deleted the fix-more-docs-issues branch April 24, 2025 15:59
@colleenmcginnis colleenmcginnis added the backport-9.0 Automated backport to the 9.0 branch label Apr 24, 2025
mergify bot pushed a commit that referenced this pull request Apr 24, 2025
@colleenmcginnis @mergify
[docs] Fix various syntax and rendering errors (#44038)
a5b3531 
* more fixes

* more fixes

* more fixes

* visually check extend

* visually check auditbeat, filebeat

* visually check heartbeat, metricbeat, packetbeat, winlogbeat

* fix remaining quickstarts

* Update docs/reference/auditbeat/auditbeat-installation-configuration.md

(cherry picked from commit 940caef)
@mergify mergify bot mentioned this pull request Apr 24, 2025
Merged
colleenmcginnis added a commit that referenced this pull request Apr 24, 2025
@mergify @colleenmcginnis
[docs] Fix various syntax and rendering errors (#44038) (#44058)
12d1cbd 
* more fixes

* more fixes

* more fixes

* visually check extend

* visually check auditbeat, filebeat

* visually check heartbeat, metricbeat, packetbeat, winlogbeat

* fix remaining quickstarts

* Update docs/reference/auditbeat/auditbeat-installation-configuration.md

(cherry picked from commit 940caef)

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@karenzone karenzone karenzone approved these changes

Assignees

@colleenmcginnis colleenmcginnis

Labels
backport-9.0 Automated backport to the 9.0 branch docs Team:Docs Label for the Observability docs team
Projects
None yet
Milestone
No milestone
Development

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