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

Links on the help&support page don't point to version-specific documentation #48201

Closed
bl-nero opened this issue Oct 31, 2024 · 3 comments
Closed
Labels
bug test-plan-problem Issues which have been surfaced by running the manual release test plan

Comments

@bl-nero
Copy link
Contributor

bl-nero commented Oct 31, 2024

Expected behavior:
Links on the help&support page should point to version-specific documentation.

Current behavior:
Links contain the expected version in the query, but the documentation page displays documentation for the latest release, as the version is expected to be a part of the URL path.

Bug details:
Teleport version: v17, v16 (perhaps earlier, too; didn't test)

@bl-nero bl-nero added bug test-plan-problem Issues which have been surfaced by running the manual release test plan labels Oct 31, 2024
@zmb3
Copy link
Collaborator

zmb3 commented Oct 31, 2024

I think this was intentional.

We used to link to version-specific pages, but customers run EOL versions of Teleport after the docs are no longer live, and end up getting broken links.

By linking to latest most times we will at least take them to the relevant page even if the version isn't quite right.

@bl-nero
Copy link
Contributor Author

bl-nero commented Oct 31, 2024

@zmb3 I think the intention here was to link to version-specific documentation, since the links contain the version information, but only the format is wrong. For example, in case of "getting started guide", the link is https://goteleport.com/docs/get-started/?product=teleport&version=oss_17.0.0-alpha.2, while it should be https://goteleport.com/docs/ver/17.x/get-started/. It means that at some point of the time, the version syntax was changed on one side, but not the other. If it was as you describe it, these links wouldn't have version information in them at all.

@zmb3
Copy link
Collaborator

zmb3 commented Oct 31, 2024

The product and version query parameters are so that we can capture the source version of Teleport and know where docs traffic originates from. They are not used for the version that renders (that comes from the URL path, as you've noted).

Here's the proof that the version in the URL path was intentionally removed: #45474

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.

@zmb3 zmb3 closed this as not planned Won't fix, can't repro, duplicate, stale Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug test-plan-problem Issues which have been surfaced by running the manual release test plan
Projects
None yet
Development

No branches or pull requests

2 participants