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.

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

Misc ReferenceDocs improvements #113667

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Misc ReferenceDocs improvements #113667

wants to merge 1 commit into from
+118 −59

Conversation

DaveCTurner
Copy link
Contributor

  • Migrate link defs to YAML, mainly to reduce noise when adding links.
  • Forbid ephemeral _auto_gen.html and page.html#_auto_gen links.
  • Remove dangling/unused BOOTSTRAP_CHECK_G1GC link.

@DaveCTurner
Misc ReferenceDocs improvements
1b0acbc 
- Migrate link defs to YAML, mainly to reduce noise when adding links.
- Forbid ephemeral `_auto_gen.html` and `page.html#_auto_gen` links.
- Remove dangling/unused `BOOTSTRAP_CHECK_G1GC` link.
@DaveCTurner DaveCTurner added :Core/Infra/Core Core issues without another label Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. v8.16.0 v9.0.0 labels Sep 27, 2024
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (Team:Core/Infra)

@elasticsearchmachine elasticsearchmachine added the Team:Core/Infra Meta label for core/infra team label Sep 27, 2024
This was referenced Sep 27, 2024
Draft
Draft
@DaveCTurner
Copy link
Contributor Author

Note that we're not currently validating these links anyway, see elastic/docs#2656

@rjernst
Copy link
Member

rjernst commented Sep 30, 2024

Why yaml? I had actually made a change to the docs build to support tab delimited txt, but lost track of the corresponding change in ES. My intention there was to be able to move reference docs into the core/lib, so it could be used in other libs. As it is now, it can't because it requires xcontent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DiannaHohensee DiannaHohensee Awaiting requested review from DiannaHohensee

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
:Core/Infra/Core Core issues without another label >non-issue Supportability Improve our (devs, SREs, support eng, users) ability to troubleshoot/self-service product better. Team:Core/Infra Meta label for core/infra team v8.16.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@DaveCTurner @elasticsearchmachine @rjernst