Sobre el proyecto

helm-www es el repositorio de helm.sh, el sitio web del proyecto del gestor de paquetes Helm. Está destinado a personas que editan la documentación de Helm, informan problemas del sitio web, publican entradas de blog o actualizan información del proyecto. El sitio está construido con Docusaurus como sitio web estático. Los colaboradores pueden instalar dependencias con yarn y ejecutar el sitio localmente con yarn start. Los cambios fusionados en la rama main se despliegan automáticamente en Netlify, donde están disponibles los registros y el estado del despliegue. El repositorio gestiona múltiples versiones de documentación. La documentación de Helm v4 se encuentra en el directorio de nivel superior docs, la documentación de Helm v3 está en versioned-docs/version-3, y la documentación más antigua de Helm v2 permanece en la rama dev-v2 del repositorio principal de Helm. Las etiquetas de versión, las rutas URL, las barras laterales, la última versión estable y la documentación preliminar se configuran a través de docusaurus.config.js, versioned_docs, versioned_sidebars y versions.json. El flujo de trabajo de documentación admite documentación preliminar en /docs/next, banners automáticos de versión no publicada, la promoción de documentación preliminar a disponibilidad general y la creación de nuevas versiones principales de documentación. La documentación comunitaria se importa desde el repositorio helm/community. El comando yarn download-remote-community obtiene y transforma ese contenido, mientras que yarn clear-remote-community elimina los archivos importados. La configuración de importación se define en docusaurus.config.js. La documentación de referencia de comandos de la CLI de Helm se puede regenerar con scripts/regenerate-cli-docs.mjs. El script descarga una versión especificada de Helm, genera documentación en el directorio de destino seleccionado y realiza posprocesamiento, como limpieza de frontmatter y conversión de enlaces. Las entradas de blog se agregan como archivos Markdown en el directorio blog con metadatos YAML para título, slug, autores y fecha. Los nuevos autores se agregan a blog/authors.yml, las imágenes del blog se almacenan en blog/images, y un marcador de truncamiento controla el resumen del índice del blog. Las solicitudes de extracción de blog requieren la aprobación de los mantenedores principales de Helm. Las contribuciones requieren commits firmados y aprobación de los mantenedores. El repositorio también proporciona una guía de estilo de documentación, notas arquitectónicas para la documentación comunitaria importada, un código de conducta y soporte de localización de documentación para traducciones.