Skip to content

[docs] Fix various syntax and rendering errors #2378

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Apr 23, 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)
  • 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:

<dependency>
<groupId>org.elasticsearch</groupId>
<artifactId>elasticsearch-hadoop</artifactId>
<version>9.0.0-beta1</version>
<version>{{version}}</version>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<version>{{version}}</version>
<version>{{version-90}}</version>

@@ -6,6 +6,7 @@ toc:
- toc: reference
- toc: release-notes
subs:
version: "9.0.0"
Copy link
Contributor

Choose a reason for hiding this comment

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

IMO we will likely need to be more specific, per discussions in elastic/docs-builder#737

Suggested change
version: "9.0.0"
version-90: "9.0.0"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was intended to be a temporary solution until elastic/docs-builder#737 is addressed and there's a central place to manage versions.

I had to add version subs to multiple repos in related PRs. I'm not planning to go back and update all other repos unless elastic/docs-builder#737 can't be addressed before the next release, but you're welcome to make this change in this repo (and any other repos) if you think that would be better.

<dependency>
<groupId>org.elasticsearch</groupId>
<artifactId>elasticsearch-hadoop-mr</artifactId> <1>
<version>9.0.0-beta1</version>
<version>{{version}}</version>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<version>{{version}}</version>
<version>{{version-90}}</version>

<dependency>
<groupId>org.elasticsearch</groupId>
<artifactId>elasticsearch-hadoop-hive</artifactId> <1>
<version>9.0.0-beta1</version>
<version>{{version}}</version>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<version>{{version}}</version>
<version>{{version-90}}</version>

<dependency>
<groupId>org.elasticsearch</groupId>
<artifactId>elasticsearch-spark-30_2.12</artifactId> <1>
<version>9.0.0-beta1</version>
<version>{{version}}</version>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<version>{{version}}</version>
<version>{{version-90}}</version>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants