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

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

Open
sftim opened this issue Apr 13, 2022 · 17 comments · May be fixed by #48722
Open

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

sftim opened this issue Apr 13, 2022 · 17 comments · May be fixed by #48722
Assignees
Labels
area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes kind/bug Categorizes issue or PR as related to a bug. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@sftim
Copy link
Contributor

sftim commented Apr 13, 2022

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 sftim added the kind/bug Categorizes issue or PR as related to a bug. label Apr 13, 2022
@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Apr 13, 2022
@sftim
Copy link
Contributor Author

sftim commented Apr 13, 2022

Insta-freezing this one
/lifecycle frozen

@k8s-ci-robot k8s-ci-robot added the lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. label Apr 13, 2022
@jasonbraganza
Copy link
Member

/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
Copy link
Contributor Author

sftim commented Apr 16, 2022

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

@sftim Yes. will do so.

@jasonbraganza
Copy link
Member

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

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

/unassign

@rahil-p
Copy link

rahil-p commented Nov 5, 2022

/assign

@divya-mohan0209
Copy link
Contributor

/triage accepted

@k8s-ci-robot k8s-ci-robot added 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 Dec 7, 2023
@divya-mohan0209
Copy link
Contributor

@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
Copy link
Contributor Author

sftim commented Dec 7, 2023

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
Copy link
Contributor Author

sftim commented Dec 7, 2023

Also see #41171

@divya-mohan0209
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

/area web-development

@k8s-ci-robot k8s-ci-robot added the area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes label Dec 7, 2023
@sftim
Copy link
Contributor Author

sftim commented Dec 7, 2023

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
Copy link
Contributor Author

sftim commented Sep 10, 2024

Help is still welcome.

This was referenced Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes kind/bug Categorizes issue or PR as related to a bug. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants