[chore] Fix references to plugin/storage
#840
Merged
Conversation
This file contains 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
Signed-off-by: Mahad Zaryab <[email protected]>
✅ Deploy Preview for romantic-neumann-1959d7 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Signed-off-by: Mahad Zaryab <[email protected]>
yurishkuro
reviewed
Feb 8, 2025
There was a problem hiding this comment.
Technically all other links are broken too, for older docs. This wasn't a great practice to link to main branch. GitHub allows referring to tags, this would be a better approach, e.g. https://github.com/jaegertracing/jaeger/tree/v1.66.0/internal/storage/v1/grpc
We have two options here
- Fix the release script that copies next-release files into a numbered release and perform substitution of
/main/for the concrete version being released. This will ensure stable links, but thenext-releasefiles will always be slightly different. - Use the versions where the file first appeared, e.g. https://github.com/jaegertracing/jaeger/tree/v1.20.0/plugin/storage/grpc still works today.
I think option 1 is better because it allows testing of the next-release files without having a versioned release (i.e. still pointing to the latest main). And we could script a codemod for old versions by changing the links to the respective versions.
We do have a link validation script for external links, it's just a PITA to run and it's too flaky to be run via CI
This was referenced Feb 9, 2025
yurishkuro
pushed a commit
that referenced
this pull request
Feb 9, 2025
## Which problem is this PR solving? - Addresses #840 (review) ## Description of the changes - Wrote a short script and ran it to replace all instances of `https://github.com/jaegertracing/jaeger/tree/main` with `https://github.com/jaegertracing/jaeger/tree/{version}` so that documentation links never go stale. ## How was this change tested? - Manually checked the links to ensure they are reachable ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits Signed-off-by: Mahad Zaryab <[email protected]>
yurishkuro
pushed a commit
that referenced
this pull request
Feb 9, 2025
…ion (#841) ## Which problem is this PR solving? - Addresses #840 (review) ## Description of the changes - Added a step to the release script to replace all instances of `https://github.com/jaegertracing/jaeger/tree/main` in `next-release/` and `next-release-v2/` with `https://github.com/jaegertracing/jaeger/tree/{version}` ## How was this change tested? - Ran the same sed command when performing the backfill in #842 ## Checklist - [x] I have read https://github.com/jaegertracing/jaeger/blob/master/CONTRIBUTING_GUIDELINES.md - [x] I have signed all commits --------- Signed-off-by: Mahad Zaryab <[email protected]>
yurishkuro
approved these changes
Feb 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Which problem is this PR solving?
Description of the changes
plugin/storagetointernal/storage/v1Checklist