kubernetes
Upgrade to Docsy 0.7.x from 0.6.0
As @SayakMukhopadhyay mentions in https://github.com/kubernetes/website/issues/49416#issuecomment-2591000539_:
Awesome, now time for the big upgrade to 0.7.0. It's going to be a doozy.
It will indeed be considerable work because of the Bootstrap upgrade, and this will test our resolve (and invite balance) between advancing work on #44002 vs #41171. That is, between doing minimal changes as we upgrade Docsy vs. starting the incremental realignment of this website's layouts with Docys's. We've already experienced this with the websites Mermaid diagram support vs. Docsy's new Mermaid support.
I'm glad to lead this effort given that I lead the upgrade to Bootstrap v5 for Docsy (https://github.com/google/docsy/issues/470). WDYT @sftim, @SayakMukhopadhyay, @nate-double-u?
I'll be happy to use this issue to track the upgrade process (as I did for https://github.com/google/docsy/issues/470).
Related:
- #41171
- #44002
- #49416
- #48725
- https://github.com/kubernetes/contributor-site/pull/569
- https://github.com/kubernetes/contributor-site/pull/563
@SayakMukhopadhyay - if you think that you have a handle on it and would like to lead the upgrade for this website, let us know.
I think I could take it on but do assist me if required 🙏🏻. Now that the 0.6.0 PR in the contribex site has been merged too, I will raise the PR for 0.7.0 there first as I already have the commits ready. Once I do that tomorrow, I will start working on this.
I think I have a general idea of what needs to be done based on the contribex upgrade but this will be much more involved since there are lots of customizations.
Let me take a look at it tomorrow.
I'm more than happy to support and not be leading the effort.
/area web-development /triage accepted
@SayakMukhopadhyay - you seem to be systematic and thorough in your work, which is great! As you work on the upgrade, I'd like to suggest that you both step through:
- Docsy's upgrade log, contain in the opening comment of https://github.com/google/docsy/issues/470, and
- Bootstrap's v5 migration guide
There are a lot of "moving parts" in this one (as you already know), and it's easy for some to slip through the cracks if we don't setup a systematic method from the start. At least that's my advice.
https://github.com/kubernetes/website/pull/48725 wasn't systematic, but it got pretty close by appearance.
I rebased https://github.com/kubernetes/website/pull/48725 upon main. Hope it's useful.
https://github.com/kubernetes/website/pull/48350 might help too (Tidy <head> for pages)
@SayakMukhopadhyay did you want to work on this? If you have time, we'd welcome the help.
Yeah @sftim I still plan to work on it. I will submit a draft PR soon.
@SayakMukhopadhyay – Should this be reassigned? It has been a little over 9 weeks since you self-assigned this issue. I’d like to avoid duplicate or unnecessary work if you’ve already made significant progress. If you’d prefer to hand it off, that’s fine—just let us know as soon as possible.
@chalin while working on this, I thought it would be better to prioritise aligning the website to be as close to Docse 0.6 as possible before doing the migration as it might make things simpler, both the migration and the alignment.
Right now, I have an open draft PR to rework the search a bit to reduce the customisation (see #49724).
@SayakMukhopadhyay - I agree that aligning sooner than later will make subsequent upgrade steps potentially much easier.
Thanks for the update: it's good to know where you're wanting to focus on. Ok then, I'll take a closer look a that draft PR and the Docsy issue that you created as soon as I can and report back.
