This repository was archived by the owner on Sep 30, 2024. It is now read-only.
doc: symlink CHANGELOG.md to docs for better search results#22918
Merged
doc: symlink CHANGELOG.md to docs for better search results#22918
Conversation
Contributor
|
Notifying subscribers in CODENOTIFY files for diff 9f7ca9f...90bdb17.
|
abeatrix
approved these changes
Jul 16, 2021
Contributor
abeatrix
left a comment
There was a problem hiding this comment.
brilliant! thank you robert!
Contributor
|
Awesome! |
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
5 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.
Include CHANGELOG in the docsite, so as to surface changelog items while searching. Seems useful for figuring out when something was added/removed/fixed, as well as find things that might not really be documented anywhere else.
Playing around with some searches, this seems to be a really nice addition to results, and I don't think it introduces too much noise
Examples
What is instrumentation? Pretty much undocumented feature, but is in the changelog: it's a kubernetes feature!
The docs say to use this
triggerObservabilityTestAlert, but I don't seem to have this functionality? In the changelog: added in 3.19!What happened to
experimentalFeatures.searchStreaming? Added in 3.25, removed in 3.29!Full page
There is a caveat with this: anchor links for
Added,Changed, etc. sections are suffixed with an index, and are thus not stable links. E.g. the3.27.0 > Addedlink today is/CHANGELOG#added-3, but in a few releases this link will no longer point to3.27.0.