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

Automatically update the command reference docs from CI

Aperta
  • Qualcosa non va?
#31 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

@boxcee-interview ci sta già lavorando.

Dal 28/6/2026.

  • #167 di @boxcee-interview — aperta

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
github-actions, go
Ambito
ci-cd, documentation, release

Direzione di ricerca

Esamina innanzitutto la configurazione CI esistente del repository CLI e le directory content/master/ e release del repository della documentazione. Ricostruisci il modo in cui viene generata la documentazione di riferimento di CLI, quindi usa create-pull-request per automatizzare gli aggiornamenti dopo le modifiche alla help e le release. Il lavoro è completato quando entrambi i percorsi di aggiornamento creano pull requests utilizzabili nella directory della documentazione appropriata.

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

Descrizione

documentation enhancement stale
What problem are you facing?

We're now able to auto-generate the CLI reference documentation for docs.crossplane.io, but have to do it manually.

How could Crossplane help solve your problem?

We should add CI jobs to:

  • Update the CLI docs in the content/master/ directory of the docs repo every time we merge a help change to main.
  • Update the CLI docs in the relevant release directory of the docs repo (e.g., content/v2.3) every time we do a release.

We can use https://github.com/peter-evans/create-pull-request to automatically create PRs to the docs repo.

Lingua principale
Go
Stelle
19
Fork
33
Merge medio
3g 10h
PR unite (30g)
24

Preparare l'ambiente

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 crossplane/cli

Tutte le issue di crossplane/cli

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.