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

[sftim]

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

google/docsy#950 marks that within the context of the Docsy theme:

• Bootstrap as a Git submodule is deprecated
• Font Awesome as a Git submodule is deprecated

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

Proposed Solution:

• Upgrade to a slightly newer version of Docsy that has improved support for the import of Bootstrap & Font Awesome via a Hugo module and a Git submodule.
• Once the upgrade is done, switch from the Git submodule way of importing things to using the Hugo module.
• Upgrade it further to 0.4.0 (or higher), to resolve this issue.

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]

Insta-freezing this one
/lifecycle frozen

[jasonbraganza]

/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 google/docsy#871

[sftim]

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]

@sftim Yes. will do so.

[jasonbraganza]

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]

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]

/unassign

[rahil-p]

/assign

[divya-mohan0209]

/triage accepted

[divya-mohan0209]

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

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]

Also see #41171

[divya-mohan0209]

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]

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:

• Upgrade to a slightly newer version of Docsy that has improved support for the import of Bootstrap & Font Awesome via a Hugo module and a Git submodule.
• Once the upgrade is done, switch from the Git submodule way of importing things to using the Hugo module.
• Upgrade it further to 0.4.0 (or higher), to resolve the issue.

Does the above sound correct to you, @sftim?

[divya-mohan0209]

/area web-development

[sftim]

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]

Help is still welcome.