operator-framework / operator-framework/operator-sdk
Port Website to Docsy Go module
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 7.7k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
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: https://github.com/google/docsy/discussions/535
Porting to module docs:
- Temp deploy preview https://deploy-preview-802--docsydocs.netlify.app/docs/updating/convert-site-to-module/
- https://github.com/google/docsy/pull/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/
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the current Hugo site setup and the Docsy conversion guide linked in the issue. Review how the custom theme overrides are currently wired, and use the linked Docsy discussion for questions about migration issues. Done means the site uses Docsy as a Go module, builds successfully, and retains the existing customizations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, hugo
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100