Misc ReferenceDocs improvements
#113667
Merged
Misc ReferenceDocs improvements
#113667
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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
added
:Core/Infra/Core
|
Documentation preview: |
|
Pinging @elastic/es-core-infra (Team:Core/Infra) |
This was referenced Sep 27, 2024
|
Note that we're not currently validating these links anyway, see elastic/docs#2656 |
|
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. |
Only because it is easy to parse correctly and has no interspersed separators (i.e. no trailing commas). But I can move this to an XContent-free format too if you'd prefer. I'll remove the format change from this PR and open a follow-up. |
DaveCTurner
added a commit
to DaveCTurner/elasticsearch
that referenced
this pull request
Oct 1, 2024
- Forbid ephemeral `_auto_gen.html` and `page.html#_auto_gen` links. - Remove dangling/unused `BOOTSTRAP_CHECK_G1GC` link. - Separate test suite into individual tests.
💚 Backport successful
|
elasticsearchmachine
pushed a commit
that referenced
this pull request
Oct 1, 2024
- Forbid ephemeral `_auto_gen.html` and `page.html#_auto_gen` links. - Remove dangling/unused `BOOTSTRAP_CHECK_G1GC` link. - Separate test suite into individual tests.
matthewabbott
pushed a commit
to matthewabbott/elasticsearch
that referenced
this pull request
Oct 4, 2024
- Forbid ephemeral `_auto_gen.html` and `page.html#_auto_gen` links. - Remove dangling/unused `BOOTSTRAP_CHECK_G1GC` link. - Separate test suite into individual tests.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
_auto_gen.htmlandpage.html#_auto_genlinks.BOOTSTRAP_CHECK_G1GClink.