Docsy upgrade

[AndiDog]

From SIG Docs mini-hackathon at Kubecon Paris 2024

[AndiDog]

An online bug report for the "Font-Awesome not found" error didn't result in a npm-compatible solution: https://discourse.gohugo.io/t/new-user-confused-by-the-current-state-of-the-theme-ecosystem/48747/4

[AndiDog]

We found the issue google/docsy#836 which gives a solution, but then the render hangs

$ hugo serve
hugo: downloading modules …

UPDATE: Scratch that, I was in a subdirectory...

[celestehorgan]

Collaborative work environment: tmux-paris-docs-sprint.celestehorgan.coder.cloudnative.coop

[hh]

◈ Starting Netlify Dev with Hugo                                                                             │·········
Start building sites …                                                                                       │·········
hugo v0.110.0-e32a493b7826d02763c3b79623952e625402b168+extended linux/amd64 BuildDate=2023-01-17T12:16:09Z Ve│·········
ndorInfo=gohugoio                                                                                            │·········
WARN 2024/03/19 13:23:07 Config 'params.algolia_docsearch' is deprecated: use 'params.search.algolia'        │·········
      For details, see https://www.docsy.dev/docs/adding-content/search/#algolia-docsearch.                  │·········
ERROR 2024/03/19 13:23:16 render of "page" failed: "/home/ii/website/node_modules/docsy/layouts/blog/baseof.h│·········
tml:17:15": execute of template failed: template: blog/single.html:17:15: executing "blog/single.html" at <pa│·········
rtial "page-meta-links.html" .>: error calling partial: "/home/ii/website/node_modules/docsy/layouts/partials│·········
/page-meta-links.html:5:36": execute of template failed: template: partials/page-meta-links.html:5:36: execut│·········
ing "partials/page-meta-links.html" at <hugo>: can't evaluate field WorkingDir in type interface {}          │·········
ERROR 2024/03/19 13:23:16 render of "page" failed: "/home/ii/website/node_modules/docsy/layouts/blog/baseof.h│·········
tml:17:15": execute of template failed: template: blog/single.html:17:15: executing "blog/single.html" at <pa│·········
rtial "page-meta-links.html" .>: error calling partial: "/home/ii/website/node_modules/docsy/layouts/partials│·········
/page-meta-links.html:5:36": execute of template failed: template: partials/page-meta-links.html:5:36: execut│·········
ing "partials/page-meta-links.html" at <hugo>: can't evaluate field WorkingDir in type interface {}          │·········
ERROR 2024/03/19 13:23:16 render of "page" failed: "/home/ii/website/node_modules/docsy/layouts/blog/baseof.h│·········
tml:17:15": execute of template failed: template: blog/single.html:17:15: executing "blog/single.html" at <pa│·········
rtial "page-meta-links.html" .>: error calling partial: "/home/ii/website/node_modules/docsy/layouts/partials│·········
/page-meta-links.html:5:36": execute of template failed: template: partials/page-meta-links.html:5:36: execut│·········
ing "partials/page-meta-links.html" at <hugo>: can't evaluate field WorkingDir in type interface {}          │·········
ERROR 2024/03/19 13:23:16 render of "page" failed: "/home/ii/website/node_modules/docsy/layouts/blog/baseof.h│·········
tml:17:15": execute of template failed: template: blog/single.html:17:15: executing "blog/single.html" at <pa│·········
rtial "page-meta-links.html" .>: error calling partial: "/home/ii/website/node_modules/docsy/layouts/partials│·········
/page-meta-links.html:5:36": execute of template failed: template: partials/page-meta-links.html:5:36: execut│·········
ing "partials/page-meta-links.html" at <hugo>: can't evaluate field WorkingDir in type interface {}          │·········
Built in 9687 ms                                                                                             │·········
Error: Error building site: failed to render pages: render of "page" failed: "/home/ii/website/node_modules/d│·········
ocsy/layouts/blog/baseof.html:17:15": execute of template failed: template: blog/single.html:17:15: executing│·········
 "blog/single.html" at <partial "page-meta-links.html" .>: error calling partial: "/home/ii/website/node_modu│·········
les/docsy/layouts/partials/page-meta-links.html:5:36": execute of template failed: template: partials/page-me│·········
ta-links.html:5:36: executing "partials/page-meta-links.html" at <hugo>: can't evaluate field WorkingDir in t│·········
ype interface {}                                                                                             │·········
⠇ Waiting for framework port 1313. This can be configured using the 'targetPort' property in the netlify.toml│·········
◈ Command failed with exit code 255: hugo serve --minify -DFE -w. Shutting down Netlify Dev server           │·········

[AndiDog]

npm run serve works for me now, let's see what the build says

[hh]

Emacs and Vim living together on the same page!

[sftim]

Looks kinda OK-ish to me (lkotm?)

The scroll behavior left pane for site navigation looks slightly weird (I tried in Firefox), but I think that's OK to fix post merge. Also the foot of the site is now missing 4 links:

Terms | Privacy | Trademarks | License

To summarize: I'd fix the footer but don't think it's important to worry about the scroll behavior.

[AndiDog]

I added the links back as follows by using the regular override mechanism with what docsy's footer partial offers:

[jmhbnz]

The deploy preview is looking great - I can't spot any issues.

Fantastic work team!

Edit: Gentle ping @ahrtr for additional review - This resolves a long standing dependency issue for our site by moving from a very old fork of docsy which was a git submodule to now bringing in a modern docsy version via npm.

[jberkus]

Looks good.

/approve
/lgtm

[nate-double-u]

This looks good, thanks so much @AndiDog, and everyone that came out to hack on this over the last week!

fixes: #748, #718, #717

/approve