R2DEVOPS
Nous simplifions la vie des développeurs
Start-up à taille humaine, nous somme basée à Montpellier comptons 6 membres dans notre équipe.
Notre mission est de simplifier la mise en place de pipelines d'automitisation des chaines d'intégration et de déploiements continus via notre plateforme : http://r2devops.io
Nous défendons des valeurs fortes : Transparence, User-centric, Partage et Efficacité, défendons l'open-source et pouvons compter sur une communauté de membres actifs via discord !
Suis nos aventures au quotidien sur Twitter : https://twitter.com/r2devops_io
Le défi: Expert en documentation GitLab tu deviendras
Theme:
Dévelopement
Lot:
Lot pour le meilleur rendu (1er place) : 800 Euro
Votre défi est d’écrire un script afin de convertir un fichier de CI/CD GitLab .gitlab-ci.yml en un fichier Markdown.
Es-tu prêt à relever le défi ? Une belle récompense attend le meilleur script !
Par où commencer ?
Nous vous conseillons d’abord de lire la documentation GitLab afin d’avoir un aperçu de ce qu’est la CI/CD.
Puis, vous pouvez mettre de côté les mots clés importants qui serront analysés dans votre script afin de générer le fichier Markdown: https://docs.gitlab.com/ee/ci/yaml/#global-keywords
Enfin réfléchissez comment vous pourriez inclure les commentaires dans le fichier de CI dans la documentation
N’hésitez également pas à piocher dans les sources afin d’avoir d’autres idées et pistes pour élaborer votre solution !
N’importe quel language de programmation est autorisé, le fichier Markdown généré doit reprendre la syntaxe et mettre en avant les parties que vous jugerez importantes pour documenter un job.
Sources
Exemple d’un job : https://gitlab.com/r2devops/hub/-/tree/latest/jobs/codespell et sa documentation générée sur le site : codespell
Répertoire comptenant des templates de fichiers CI : https://gitlab.com/gitlab-org/gitlab-foss/-/tree/master/lib/gitlab/ci/templates
Elements attendus
- Le fichier de scripting
- La documentation technique et fonctionnelle qui doit être en relation avec le sujet de la Nuit de l'Info
Mode de restitution
Un mail à arsene@r2devops.io contenant l'url du répertoire git