pulp / pulp/pulp-docs

Create managed files for pulp-docs on ALL components

Open
#183 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic
Dominant language
HTML
Stars
2
Forks
17
Avg merge
7d 18h
Merged PRs (30d)
3

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing pulp_template and the reusable GitHub workflow already mentioned for component docs CI. Define how non-plugin components opt in and how managed files are distributed across all components. Done should include compliance checks and auto-fixes plus canonical docs build, serve, and lint commands.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.