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

Update DOCS_BASE to v2.10 #11114

Closed
richard-cox opened this issue May 24, 2024 · 21 comments
Closed

Update DOCS_BASE to v2.10 #11114

richard-cox opened this issue May 24, 2024 · 21 comments
Assignees
Labels
docs-impact Label for design changes that will require documentation to be updated kind/enhancement priority/0 QA/dev-automation Issues that engineers have written automation around so QA doesn't have look at this size/1 Size Estimate 1
Milestone

Comments

@richard-cox
Copy link
Member

richard-cox commented May 24, 2024

  • Current DOCS_BASE points to https://ranchermanager.docs.rancher.com/v2.8 (2.9 soon Update DOCS_BASE to v2.9 #10766)
  • When 2.10 becomes available value needs updating
  • Need to sync with docs team on when this will be

Alternatively we need a way to automate this

@richard-cox richard-cox added kind/bug priority/1 docs-impact Label for design changes that will require documentation to be updated labels May 24, 2024
@richard-cox richard-cox added this to the v2.10.0 milestone May 24, 2024
@github-actions github-actions bot added the QA/dev-automation Issues that engineers have written automation around so QA doesn't have look at this label May 24, 2024
@nwmac nwmac modified the milestones: v2.10.0, v2.11.0 Jul 4, 2024
@gaktive gaktive modified the milestones: v2.11.0, v2.10.0 Jul 4, 2024
@gaktive
Copy link
Member

gaktive commented Oct 2, 2024

Release team may be able to help going forward. @rak-phillip to check.
Past efforts on automation: #7149

@nwmac is working on another ticket to handle an upcoming URL structure change.

@gaktive gaktive added the size/1 Size Estimate 1 label Oct 2, 2024
@gaktive
Copy link
Member

gaktive commented Oct 24, 2024

@gunamata while we wait for the list of changes, based on the number of links we have already, we'll likely need redirects in place already for 2.10 according to @nwmac as code freeze is coming up fast. Do let us know what the new URLs are still.

@gunamata
Copy link

gunamata commented Oct 24, 2024

@gunamata
Copy link

A quick question about the implementation. The new links proposed would be used only for the Prime versions correct?

@momesgin
Copy link
Member

@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.

@nwmac
Copy link
Member

nwmac commented Oct 28, 2024

@gaktive we do not have time to change any links or have different links for prime

@gunamata
Copy link

@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.

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.
yes, that's the requirement.

@gaktive
Copy link
Member

gaktive commented Oct 28, 2024

@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?

@gunamata
Copy link

@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.

@gaktive
Copy link
Member

gaktive commented Oct 28, 2024

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.

@nwmac
Copy link
Member

nwmac commented Oct 28, 2024

@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.

@gunamata
Copy link

@gaktive , @nwmac - 2.10.0 community docs links have not changed (except for the obvious version part).
@btat , Keep me honest here.

@btat
Copy link

btat commented Oct 28, 2024

@gaktive @nwmac @gunamata We'll have the 2.10 preview docs set, and the redirects for the specific links in the spreadsheet, available later this week.

@momesgin
Copy link
Member

@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
Copy link
Member

gaktive commented Oct 28, 2024

Thanks @momesgin -- I filed a new ticket #12384 to start figuring out what to do there.

And thanks @btat for getting redirects prepared!

@nwmac
Copy link
Member

nwmac commented Oct 29, 2024

@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.

@gaktive
Copy link
Member

gaktive commented Oct 29, 2024

@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.

@btat
Copy link

btat commented Oct 30, 2024

2.10 docs and redirects are active now.

@izaac
Copy link
Contributor

izaac commented Oct 30, 2024

@momesgin is this coming organically to 2.10 after the 2.9 PR here ? Or does this have a 2.10 specific PR?

@momesgin
Copy link
Member

@izaac Here's the actual PR that the updating the version to 2.10 was part of it.

@izaac
Copy link
Contributor

izaac commented Oct 30, 2024

Validated on Rancher version: v2.10-10e26d1256a15f76e27a41184d92c4b8781dd94b-head
UI version: master 6dd2962

Support Links, Home Links and Charts links redirect to the 2.10 pages as expected of the Rancher Manager docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-impact Label for design changes that will require documentation to be updated kind/enhancement priority/0 QA/dev-automation Issues that engineers have written automation around so QA doesn't have look at this size/1 Size Estimate 1
Projects
None yet
Development

No branches or pull requests

7 participants