Skip to content
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

[DOCS] Fix Bad Links in Java High-Level Search API Docs for Asciidoctor Migration #41505

Merged
merged 1 commit into from
Apr 24, 2019
Merged

[DOCS] Fix Bad Links in Java High-Level Search API Docs for Asciidoctor Migration #41505

merged 1 commit into from
Apr 24, 2019

Conversation

jrodewig
Copy link
Contributor

The 6.5 docs for the Search API of our Java High Level REST Client link to an auto-generated anchor.

This is bad practice generally, but the link breaks in Asciidoctor. This PR:

  1. Creates a specified ID for the anchors.
  2. Updates the Search API docs to use those new ID anchors.

I plan to backport this to 5.6.

Relates to #41128 and elastic/docs#827.

@jrodewig jrodewig added >docs General docs changes :Docs labels Apr 24, 2019
@jrodewig jrodewig requested review from nik9000 and tlrx April 24, 2019 19:11
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

Copy link
Member

@nik9000 nik9000 left a comment

Choose a reason for hiding this comment

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

LGTM

@jrodewig jrodewig merged commit 37e275f into elastic:6.5 Apr 24, 2019
@jrodewig jrodewig deleted the fix-asciidoctor-errors-java-rest-links branch April 24, 2019 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants