Skip to content

Create managed files for pulp-docs on ALL components #183

Description

@pedro-psb

Because there isn't an integrated system for distributing doc-related changes, modifying something in the docs infrastructure is painful and error-prone, which makes the development of pulp-docs brittle.

Generally we could use https://github.com/pulp/pulp_template for managing all plugin templates, but that doesn't apply to components (pulp-docs components) which are not plugins, for example, pulp-docs itself, pulp-cli, pulp-oci-images, etc. Probably we could extend it to all components, and non-plugins would opt-in only for docs. This is my prefered implementation approach.

I've started creating a re-usable github workflow for managing the component's docs CI, but it's not enough.
Some features that this would enable (and are important for future development) are:

  • Checks and auto-fixes of compliance with new infrastructure change (e.g, folder names, a new docs config, formatting, etc)
  • Managing a docs command runner (make docs-build/serve, ...) for canonical ways of build, serving and linting plugin-specific documentation.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions