TechDocs
La documentation technique de chaque service, au même endroit
La documentation s’écrit en Markdown dans le dépôt qu’elle décrit et Fenwave la publie à côté du propriétaire du service, de ses APIs et de ses dépendances. Plus personne ne fouille wikis, drives et READMEs pour comprendre un service — et comme la doc vit avec le code, elle change dans la même pull request.
Dans cette fonctionnalité
- Docs-as-code : un mkdocs.yml dans le dépôt est détecté et publié
- Un squelette de documentation ajouté par pull request aux dépôts nouveaux et existants
- Le README du dépôt affiché pour tout service encore sans documentation
- Une seule recherche dans la documentation de tous les services
- Le manuel de la plateforme, en anglais et en français, au même endroit
Dans Fenwave
Explore›Docs›checkout-api
Repose sur
- TechDocs
- MkDocs
- Markdown
Aussi dans Catalogue et documentation
- Service CatalogChaque service, son propriétaire, et ce qui casse s’il s’arrête
- Architecture ExplorerLe schéma d’architecture que personne n’a à redessiner
Voyez Fenwave sur vos propres projets
Trente minutes, sur vos dépôts et vos clusters. Nous repérons ensemble trois demandes que votre équipe plateforme n’aurait plus à traiter dès la semaine prochaine.