-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Open
Labels
help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.Indicates that an issue or PR should not be auto-closed due to staleness.needs discussionpriority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Milestone
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: google/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 google/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/
Metadata
Metadata
Assignees
Labels
help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.Indicates that an issue or PR should not be auto-closed due to staleness.needs discussionpriority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.Important over the long term, but may not be staffed and/or may need multiple releases to complete.