Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v14] Remove /ver/ segments from Web UI docs links #45506

Merged
merged 2 commits into from
Sep 9, 2024

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Aug 14, 2024

Backports #45474

The Support component is the only Web UI component that renders docs links that include the /ver/ path segment. This change removes the /ver/ path segment from these links so they point to the default version of the docs. The user can use the version dropdown within the docs site to adjust the version. This change does not alter UTM parameters.

With this change, we only need to manage redirects in the default version of the docs site. This makes it less likely that users will encounter 404 errors. And since the docs site only displays the current version and previous two versions, link targets with the /ver/ segment will 404 in EOL Teleport versions. This change also prevents that scenario.

Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott ptgott force-pushed the paul.gottschling/45474-bp-v14 branch from c198ed0 to 2d39f31 Compare August 15, 2024 12:17
Copy link

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott ptgott added the no-changelog Indicates that a PR does not require a changelog entry label Aug 28, 2024
@ptgott ptgott enabled auto-merge August 28, 2024 19:30
@ptgott ptgott force-pushed the paul.gottschling/45474-bp-v14 branch from 2d39f31 to f37b861 Compare August 28, 2024 19:30
@ptgott ptgott force-pushed the paul.gottschling/45474-bp-v14 branch 3 times, most recently from 0f57562 to 225fc7f Compare September 5, 2024 20:45
Backports #45474

The Support component is the only Web UI component that renders docs
links that include the `/ver/` path segment. This change removes the
`/ver/` path segment from these links so they point to the default
version of the docs. The user can use the version dropdown within the
docs site to adjust the version. This change does not alter UTM
parameters.

With this change, we only need to manage redirects in the default
version of the docs site. This makes it less likely that users will
encounter 404 errors. And since the docs site only displays the current
version and previous two versions, link targets with the `/ver/` segment
will 404 in EOL Teleport versions. This change also prevents that
scenario.
@ptgott ptgott force-pushed the paul.gottschling/45474-bp-v14 branch from 225fc7f to 1977715 Compare September 9, 2024 13:08
@ptgott ptgott force-pushed the paul.gottschling/45474-bp-v14 branch from 1977715 to fd8ca44 Compare September 9, 2024 13:48
@ptgott ptgott added this pull request to the merge queue Sep 9, 2024
Merged via the queue into branch/v14 with commit 8282603 Sep 9, 2024
27 checks passed
@ptgott ptgott deleted the paul.gottschling/45474-bp-v14 branch September 9, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport no-changelog Indicates that a PR does not require a changelog entry size/sm ui
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants