search

kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.44k stars 14.3k forks source link

Bootstrap and Font Awesome (as part of Docsy) are deprecated #32905

Open sftim opened 2 years ago

sftim commented 2 years ago

This is a Bug Report

Problem:

Currently, the Kubernetes website uses v0.2.0 of the Docsy theme on Hugo and we import it via Git submodules during Netlify and local builds. As of v.0.4.0, the theme deprecated the import of Bootstrap & Font Awesome via Git submodules. We still need to continue using these and are running on a wildly outdated Docsy version (the latest Docsy version is v0.8.0).

https://github.com/google/docsy/discussions/950 marks that within the context of the Docsy theme:

Docsy still use these things, but the recommended. mechanism for that is no longer Git submodules.

Proposed Solution:

Additional Information: For the slightly newer version, pick 0.3.x (or 0.4.0 if 0.3.x doesn't work) We should bump to the newest 0.4.x for fixing this issue; a separate issue tracks bumping to the very latest Docsy.

sftim commented 2 years ago

Insta-freezing this one /lifecycle frozen

jasonbraganza commented 2 years ago

/assign

New to the community and would love to contribute. This seems like something that is a gentle stretch for me and I’d love to pick it up.

Am going to try building the site locally first and then …

Try to change the build by bringing in Docsy as a Hugo module, using the approach outlined here in https://github.com/google/docsy/pull/871/

sftim commented 2 years ago

If you're picking this up @jasonbraganza then as well as the local dev story, you will need to tweak the live and preview publication mechanisms that are configured in netlify.toml.

jasonbraganza commented 2 years ago

@sftim Yes. will do so.

jasonbraganza commented 2 years ago

just an update have not gotten anything done yet. going through a slightly rough patch. will come back to this and work in general, hopefully midweek next.

jasonbraganza commented 2 years ago

i cannot seem to make progress at this. will come back to this some other day Meanwhile, I’ll unassign myself, for other good folk to pick up.

jasonbraganza commented 2 years ago

/unassign

rahil-p commented 1 year ago

/assign

divya-mohan0209 commented 9 months ago

/triage accepted

divya-mohan0209 commented 9 months ago

@sftim, if I understand correctly, we still use the git submodule way to build the site locally and via Netlify. However, the challenge is that we need to have these scripts separately installed for Netlify and local builds using this comment? I'm assuming given the timeline of this issue, we're currently not using these two. However, would having these improve the UX of our website?

sftim commented 9 months ago

I think the way forward is to bump to a slightly newer version of Docsy - one that has good support for being imported as a Hugo module not as a Git submodule.

Then, having done that bump, switch to using that support: drop the submodule, and use Docsy as a Hugo module.

At that point, we then do a further small bump to the Docsy version, enough to resolve this issue.

sftim commented 9 months ago

Also see https://github.com/kubernetes/website/issues/41171

divya-mohan0209 commented 9 months ago

I think the way forward is to bump to a slightly newer version of Docsy - one that has good support for being imported as a Hugo module not as a Git submodule.

Then, having done that bump, switch to using that support: drop the submodule, and use Docsy as a Hugo module.

At that point, we then do a further small bump to the Docsy version, enough to resolve this issue.

That does make sense.

divya-mohan0209 commented 9 months ago

Rephrasing it all for better clarity,

What's the issue?

Currently, the Kubernetes website uses v0.2.0 of the Docsy theme on Hugo and we import it via Git submodules during Netlify and local builds. As of v.0.4.0, the theme deprecated the import of Bootstrap & Font Awesome via Git submodules. We still need to continue using these and are running on a wildly outdated Docsy version (the latest Docsy version is v0.8.0)

Proposed solution:

Does the above sound correct to you, @sftim?

divya-mohan0209 commented 9 months ago

/area web-development

sftim commented 9 months ago

For the slightly newer version, pick 0.3.x (or 0.4.0 if 0.3.x doesn't work) We should bump to the newest 0.4.x for fixing this issue; a separate issue tracks bumping to the very latest Docsy.

sftim commented 4 days ago

Help is still welcome.