Move plugin-architecture Piped usage guide to official documentation

Abierto
#6,742 2 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

@A-d-i-t-y ya está trabajando en esto.

Desde el 17/5/2026.

  • #6785 de @A-d-i-t-y — cerrado sin fusionar

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
68/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
hugo

Línea de trabajo

Comienza leyendo cmd/pipedv1/README-usage-alpha.md y las páginas relacionadas bajo docs/content/en/docs-v1.0.x/installation/install-piped/. Mueve las secciones Prerequisites, Setup Control Plane, Run Piped y Deploy an Application a plugin-architecture.md, actualiza los enlaces internos y el aviso de alpha, y después convierte la README en un puntero a la nueva página. La tarea estará terminada cuando el contenido se pueda descubrir en la documentación oficial, tenga un formato Hugo coherente y los enlaces funcionen.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

kind/enhancement

*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 inside cmd/
  • 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
Lenguaje dominante
Go
Estrellas
1.4k
Forks
391
Merge medio
4 d 1 h
PR fusionados (30 d)
58

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de pipe-cd/pipecd

Todos los issues de pipe-cd/pipecd

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.