Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Create managed files for pulp-docs on ALL components

Aperta
#183 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
github-actions
Ambito
ci-cd, documentation, tooling

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

epic

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.
Lingua principale
HTML
Stelle
2
Fork
17
Merge medio
7g 18h
PR unite (30g)
3

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pulp/pulp-docs

Tutte le issue di pulp/pulp-docs

Issue simili

Altre issue su DevOps

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.