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.

Sign up for GitHub

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

Jump to bottom

Upgrade to Docsy 0.7.x from 0.6.0 #49430

Open
chalin opened this issue Jan 14, 2025 · 7 comments
Open

Upgrade to Docsy 0.7.x from 0.6.0 #49430

chalin opened this issue Jan 14, 2025 · 7 comments
Labels
area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@chalin
Copy link
Contributor

chalin commented Jan 14, 2025 •
edited
Loading

As @SayakMukhopadhyay mentions in #49416 (comment)_:

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 (google/docsy#470). WDYT @sftim, @SayakMukhopadhyay, @nate-double-u?

I'll be happy to use this issue to track the upgrade process (as I did for google/docsy#470).

Related:
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jan 14, 2025
@chalin
Copy link
Contributor Author

chalin commented Jan 14, 2025

@SayakMukhopadhyay - if you think that you have a handle on it and would like to lead the upgrade for this website, let us know.

@SayakMukhopadhyay
Copy link
Contributor

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.

@sftim
Copy link
Contributor

sftim commented Jan 14, 2025

I'm more than happy to support and not be leading the effort.

/area web-development
/triage accepted

@k8s-ci-robot k8s-ci-robot added area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 14, 2025
@chalin
Copy link
Contributor Author

chalin commented Jan 14, 2025

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

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.

@sftim
Copy link
Contributor

sftim commented Jan 14, 2025

#48725 wasn't systematic, but it got pretty close by appearance.

@sftim
Copy link
Contributor

sftim commented Jan 14, 2025

I rebased #48725 upon main. Hope it's useful.

@sftim
Copy link
Contributor

sftim commented Jan 14, 2025

#48350 might help too (Tidy <head> for pages)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@chalin @SayakMukhopadhyay @k8s-ci-robot @sftim