-
Notifications
You must be signed in to change notification settings - Fork 266
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
Update DOCS_BASE to v2.10 #11114
Comments
Release team may be able to help going forward. @rak-phillip to check. @nwmac is working on another ticket to handle an upcoming URL structure change. |
@gaktive , You can find the new links in the spreadsheet below. |
A quick question about the implementation. The new links proposed would be used only for the Prime versions correct? |
@gunamata thank you for providing the new links. I'm a bit confused though as I see 2.9 being used there for the new links for both community and prime, but this issue has the 2.10 milestone. Could you please clarify on what exactly needs to be done? Regarding your question, I think this will be first time we differentiate the doc links based on the prime version, and if that's the requirement then the answer is yes. |
@gaktive we do not have time to change any links or have different links for prime |
@momesgin , Good catch, the version numbers in the spreadsheet are just placeholders and need to be adjusted for the specific rancher version being worked on.
|
@gunamata as noted, UI is running up at time to get the links updated in the dashboard code. Could Docs do redirects for the old links to the new ones with the 2.10 version? Otherwise, I see both community & prime links there so I don't know if community users are intended to view prime docs. If not, then UI will need some new logic to detect and differentiate to show the appropriate docs. Should we default to community only for now? Then later, show prime for prime users? |
@gaktive , It's not possible to do the redirects from the docs side as we would not know the context (community or prime) the link is being accessed. I understand it's late in the cycle :( , if it's not possible to squeeze this into 2.10 then we need to do this in the next set of prime releases. Yes, the UI will need some logic to detect and point to different docs. The idea is that community version would continue to point to the current links being used in the UI today. The Prime version needs to use the new links provided in the doc. I understand that the already released prime versions will point to community docs and it's a known limitation/behavior. |
OK thanks @gunamata could we do redirects for community 2.10.0 at least? I'll file a ticket to look at detecting community vs. prime so that for the 2.10.1 prime release, we can see what's possible. |
@gunamata UI will handle the two sets of links, but not for 2.10.0, so both prime and community will get the community links. We do the need community links for 2.10 put in place though. |
@gaktive based on the discussion above, and the fact that we're already using 2.10 in the code for the urls, we should be fine closing this issue later this week probably after a quick test, unless we want to keep this open and update the requirement to cover the implementation of dynamic links based on prime & community versions. |
@gaktive We need to work on getting links in place BEFORE code freeze in the future - we can't actually test that the links are working correctly as is. |
@nwmac indeed For now, let's get the new links in with anticipation that the redirects are in place. Timing ideally should have this done before code freeze but QA may have to keep us honest. |
2.10 docs and redirects are active now. |
@izaac Here's the actual PR that the updating the version to 2.10 was part of it. |
Validated on Rancher version: Support Links, Home Links and Charts links redirect to the 2.10 pages as expected of the Rancher Manager docs. |
DOCS_BASE
points tohttps://ranchermanager.docs.rancher.com/v2.8
(2.9 soon UpdateDOCS_BASE
to v2.9 #10766)Alternatively we need a way to automate this
The text was updated successfully, but these errors were encountered: