Move plugin-architecture Piped usage guide to official documentation
I maintainer di solito rispondono entro 2 giorni
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 68/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Stack tecnologico
- hugo
- Ambito
- documentation
Direzione di ricerca
Inizia leggendo cmd/pipedv1/README-usage-alpha.md e le pagine correlate in docs/content/en/docs-v1.0.x/installation/install-piped/. Sposta le sezioni Prerequisites, Setup Control Plane, Run Piped e Deploy an Application in plugin-architecture.md, aggiorna i link interni e l'avviso alpha, quindi trasforma la README in un puntatore alla nuova pagina. Il lavoro è completo quando il contenuto è individuabile nella documentazione ufficiale, usa una formattazione Hugo coerente e contiene link funzionanti.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
*What would you like to be added:
Move the plugin-architecture Piped usage guide from:
cmd/pipedv1/README-usage-alpha.md
to the official documentation under:
docs/content/en/docs-v1.0.x/installation/install-piped/plugin-architecture.md
This would include:
- Migrating all relevant sections (Prerequisites, Setup Control Plane, Run Piped, Deploy an Application)
- Replacing the "alpha" notice with a proper Hugo alert block
- Updating internal links to align with documentation pages
- Converting the existing README into a pointer to the new documentation
Why is this needed:
- Improves discoverability, as users typically look for installation guidance in the official
docs/directory rather than insidecmd/ - Provides a more structured and complete documentation experience
- Reduces maintenance overhead by leveraging Hugo-based docs (versioning, search, consistent styling)
- Improves onboarding for new users and contributors by centralizing important usage instructions
- Lingua principale
- Go
- Stelle
- 1.4k
- Fork
- 391
- Merge medio
- 4g 1h
- PR unite (30g)
- 58
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di pipe-cd/pipecd
-
Applications at the repository root are not triggered by new commitsForse già presa @Daksha1611 l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
I maintainer di solito rispondono entro 2 giorni
-
pipedv1 kubernetes plugins ignore trafficRouting.istio.host in K8S_TRAFFIC_ROUTINGForse già presa @Dhirenderchoudhary l’ha presa oggi. Aperta
Difficoltà 2/5 Mezza giornata Idoneità per principianti 74/100
pipe-cd/pipecd#7626 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 2 giorni
-
pipectl transfer restore application drops backed-up labelsForse già presa @bhavishyajain545 l’ha presa 1 giorno fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
pipe-cd/pipecd#7622 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
I maintainer di solito rispondono entro 2 giorni
Tutte le issue di pipe-cd/pipecd
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
docker-compose: postgres healthcheck should probe TCP (pg_isready -h localhost)Forse già presa @zezo-mohamed22 l’ha presa oggi. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
OneBusAway/watchdog#305 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
self-care self-care:agent-discoverability
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
githubnext/gh-cao#20928 ·
I maintainer di solito rispondono entro 1 giorno
-
automation documentation
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 70/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
SocialGouv/iterion#3287 ·
I maintainer di solito rispondono entro 1 giorno