Skip to content

Port Website to Docsy Go module #5496

@asmacdo

Description

@asmacdo

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:

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

No one assigned

    Labels

    help wantedDenotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.kind/documentationCategorizes issue or PR as related to documentation.lifecycle/frozenIndicates 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.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions