helm-www

helm-www est le dépôt de helm.sh, le site web du projet de gestionnaire de paquets Helm. Il s'adresse aux personnes qui modifient la documentation Helm, signalent des problèmes sur le site, publient des articles de blog ou mettent à jour les informations du projet. Le site est construit avec Docusaurus sous forme de site statique. Les contributeurs peuvent installer les dépendances avec yarn et exécuter le site localement avec yarn start. Les modifications fusionnées dans la branche main sont automatiquement déployées sur Netlify, où les journaux et l'état du déploiement sont disponibles. Le dépôt gère plusieurs versions de documentation. La documentation Helm v4 se trouve dans le répertoire docs de premier niveau, la documentation Helm v3 se trouve dans versioned-docs/version-3, et l'ancienne documentation Helm v2 reste dans la branche dev-v2 du dépôt principal Helm. Les libellés de version, les chemins d'URL, les barres latérales, la dernière version stable et la documentation de pré-version sont configurés via docusaurus.config.js, versioned_docs, versioned_sidebars et versions.json. Le flux de travail de documentation prend en charge les documents de pré-version sous /docs/next, les bannières automatiques de version non publiée, la promotion de la documentation de pré-version vers la disponibilité générale et la création de nouvelles versions majeures de documentation. La documentation communautaire est importée depuis le dépôt helm/community. La commande yarn download-remote-community récupère et transforme ce contenu, tandis que yarn clear-remote-community supprime les fichiers importés. La configuration d'importation est définie dans docusaurus.config.js. La documentation de référence des commandes CLI Helm peut être régénérée avec scripts/regenerate-cli-docs.mjs. Le script télécharge une version spécifiée de Helm, génère la documentation dans le répertoire cible sélectionné et effectue un post-traitement tel que le nettoyage du frontmatter et la conversion des liens. Les articles de blog sont ajoutés sous forme de fichiers Markdown dans le répertoire blog avec des métadonnées YAML pour le titre, le slug, les auteurs et la date. Les nouveaux auteurs sont ajoutés à blog/authors.yml, les images de blog sont stockées dans blog/images, et un marqueur de troncature contrôle le résumé de l'index du blog. Les pull requests de blog nécessitent l'approbation des mainteneurs principaux de Helm. Les contributions nécessitent des commits signés et l'approbation des mainteneurs. Le dépôt fournit également un guide de style de documentation, des notes architecturales pour la documentation communautaire importée, un code de conduite et une prise en charge de la localisation de la documentation pour les traductions.