chore(docs): fix broken upgrade guide link in banner #2091
Merged
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.
Description of your changes
This PR fixes the broken relative link to the v2 upgrade guide in the docs (see image below for reference).
Before merging the PR with the banner I tested it locally and verified that the link was working fine, however while working on this PR I verified again and realized that it's not possible to test this type of url locally because when running the docs locally we are missing the
/<version>
path from the url.In most of the doc links this is not a problem, however for links interpolated in the
overrides
this seems to be an issue.I couldn't find the proper way of doing it according to MKDocs Material conventions so I opted for hardcoding the
/latest
path; mainly because this is a temporary one-off link.Related issues, RFCs
Issue number: #2090
Checklist
Breaking change checklist
Is it a breaking change?: NO
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.