Docs-as-code sur Etsy

Les documents en tant que code intègrent la documentation dans le développement en utilisant les mêmes outils et les mêmes procédures que le code. Il met l'accent sur la versionning, la mise en page en texte brut et l'automatisation pour améliorer la gestion de la documentation. L'outil Docsbuilder d'Etsy emploie Markdown, Docusaurus et des workflows GitOps pour la création et la maintenance de la documentation. Docsbuilder automatise la création du site, la validation et le déploiement avec Google Cloud Build et des tests d'intégration. Docsbuilder permet la découverte avec un moteur de recherche et un composant de navigation pour les sites fréquemment utilisés. Etsy héberge actuellement plus de 6,2 k pages sur 150 sites Docsbuilder. L'objectif du docs-as-code est d'améliorer la qualité, l'efficacité et la fiabilité de la documentation. Les principes clés incluent le traitement de la documentation comme un citoyen de premier rang, la versionning dans Git, l'utilisation de formats de texte brut et l'automatisation des workflows. Docs-as-code encourage les développeurs à aborder la documentation avec la même rigueur que la programmation. Etsy prévoit d'améliorer la découverte, la navigation et l'engagement du contenu au sein de Docsbuilder. Docs-as-code favorise une approche équilibrée entre la documentation et la programmation, menant à une documentation organisée et maintenable.