Repository navigation
Port Website to Docsy Go module #5496
Description
Operator Framework sites are built with Hugo and the Docsy theme, which was previously versioned as a git submodule. We had to go pretty far outside of the accepted best practices to get our custom theme, and it has prevented us from migrating to newer versions of docsy.
Docsy is now available as a go module plugin to hugo instead, which should be significantly easier to upgrade.
Original discussion: docsy/docsy#535
Porting to module docs:
- Temp deploy preview https://deploy-preview-802--docsydocs.netlify.app/docs/updating/convert-site-to-module/
- User guide: adding instructions on how to use and update docsy as hugo module docsy/docsy#802
We will likely run into some trouble here, since we did so much beyond-best-practice stuff to override our custom theme. If we do, the best place ask questions here https://github.com/google/docsy/discussions/
Activity
asmacdo commentedon Jan 13, 2022
The part of this to watch for is whether we can cleanly override the docsy theme. If that part does not go smoothly, this could be a significant amount of front-end work.
deining commentedon Jan 18, 2022
The author that ported docsy theme to a module here 😄.
I might be able to help you out in the transition of your documenation to dosy hugo module.
Having a look at your website
folder, I realized, that it's content is not self-contained yet. I have no idea what revision/commit of the docsy theme you are using. Are you able to add the docsy theme as a submodule, at the revision that your production site uses right now? Once I'm able to clone your site and run it locally, I will try to add the option to convert/use it as module. Your site can still use submodules, I should be able to bring it into a state where you can switch back and forth between module and submodule quite easily.I was curious and had a first quick glance and I immediately realized that your site/repo has to be reworked on several places to make it compatible with modules. So don't be deceived: while hugo modules are great, they are by no means a magic wand that will upgrade your site to the latest version without manual rework.
openshift-bot commentedon Apr 25, 2022
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting
/remove-lifecycle stale.Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting
/lifecycle frozen.If this issue is safe to close now please do so with
/close./lifecycle stale
asmacdo commentedon Apr 26, 2022
/lifecycle frozen
openshift-bot commentedon Sep 28, 2022
Issues go stale after 90d of inactivity.
Mark the issue as fresh by commenting
/remove-lifecycle stale.Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting
/lifecycle frozen.If this issue is safe to close now please do so with
/close./lifecycle stale
jberkhahn commentedon Oct 12, 2022
/lifecycle-frozen
jberkhahn commentedon Oct 12, 2022
/lifecycle frozen