Skip to content

Conversation

@dreamorosi
Copy link
Contributor

Description of your changes

This PR fixes the broken relative link to the v2 upgrade guide in the docs (see image below for reference).

Screenshot 2024-02-19 at 14 55 04

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

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

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.

@dreamorosi dreamorosi self-assigned this Feb 19, 2024
@dreamorosi dreamorosi requested a review from a team February 19, 2024 14:56
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Feb 19, 2024
@pull-request-size pull-request-size bot added the size/XS PR between 0-9 LOC label Feb 19, 2024
@dreamorosi dreamorosi linked an issue Feb 19, 2024 that may be closed by this pull request
@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@dreamorosi dreamorosi merged commit 2d82117 into main Feb 19, 2024
@dreamorosi dreamorosi deleted the chore/docs_upgrade_link branch February 19, 2024 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XS PR between 0-9 LOC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: fix link in announcement banner

2 participants