Skip to content

Commit

Permalink
Translated Readme and Repo creation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
RussellJimmies committed Jan 22, 2025
1 parent f18f2ea commit 4b71be0
Show file tree
Hide file tree
Showing 2 changed files with 137 additions and 5 deletions.
53 changes: 49 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# DevOps Repository for AI-CFIA
# DevOps Repository for the CFIA AI Lab

([*Le français est disponible au bas de la
page*](#dépôt-devops-pour-le-labo-dia-de-lacia))

This repository contains scripts, configurations, and documentation related to
the DevOps practices at AI-CFIA. It's designed to help team members set up,
deploy, and manage applications on various platforms.
the DevOps practices at the CFIA AI Lab. It's designed to help team members set
up, deploy, and manage applications on various platforms.

## Contents

Expand All @@ -24,4 +27,46 @@ deploy, and manage applications on various platforms.
## Related Repositories

- [Dev-Rel-Docs](https://github.com/ai-cfia/dev-rel-docs): Contains introduction
files and documentation related to developer relations at AI-CFIA.
files and documentation related to developer relations at the CFIA AI Lab.
- [Howard](https://github.com/ai-cfia/howard): Manages the CFIA AI Lab's
Kubernetes-based cloud infrastructure.
- [Howard-On-Prem](https://github.com/ai-cfia/howard-on-prem): Handles the CFIA
AI Lab's Kubernetes on-premise infrastructure.

---

## Dépôt DevOps pour le labo d'IA de l'ACIA

Ce dépôt contient des scripts, des configurations et de la documentation liés
aux pratiques DevOps du labo d'IA de l'ACIA. Il est conçu pour aider les membres
de l'équipe à configurer, déployer et gérer des applications sur diverses
plateformes.

## Contenu

- **Configuration GCP** : Cette section contient des scripts d'automatisation
conçus pour simplifier la configuration de GCP. Elle inclut des tâches comme
l'initialisation d'un nouveau projet, l'association d'un compte de
facturation, l'orchestration d'un dépôt d'artéfacts et la création d'un compte
de service. Une documentation complète est fournie pour vous guider dans
l'exécution des scripts.

- **Guide de création de dépôts GitHub** : Ce guide explique comment créer un
nouveau dépôt conforme aux normes de l'ACIA.

## Premiers Pas

1. Clonez ce dépôt.
2. Accédez au script ou à la documentation souhaitée.
3. Suivez les instructions fournies dans chaque script ou document.

## Dépôts connexes

- [Dev-Rel-Docs](https://github.com/ai-cfia/dev-rel-docs) : Contient des
fichiers d'introduction et des documentations relatives aux relations
développeurs à l'AI-CFIA.
- [Howard](https://github.com/ai-cfia/howard): Gère l'infrastructure cloud basée
sur Kubernetes du laboratoire d'IA de l'ACIA.
- [Howard-On-Prem](https://github.com/ai-cfia/howard-on-prem): Gère
l'infrastructure Kubernetes sur site du laboratoire d'IA de l'ACIA.

89 changes: 88 additions & 1 deletion github-repository-creation-guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# GitHub Repository Creation Guide

([*Le français est disponible au bas de la
page*](#guide-de-création-de-dépôt-github))

When creating a GitHub repository you need to follow a few organizational
standardization rules :

Expand Down Expand Up @@ -64,11 +67,95 @@ To enable these functionalities:
1. From the main page of your repository, click **Settings**. ![Repository
Settings](./images/{186D1DE0-B70F-4DAA-8267-D8029BB90F66}.png)

1. In the sidebar, scroll down to the **Security** section and click **Code security**.
1. In the sidebar, scroll down to the **Security** section and click **Code
security**.

1. Scroll down to the **Secret scanning** section and click **Enable**. ![Enable
Secret scanning](./images/{88B79545-E575-41D6-AAB5-EBD53195E25F}.png)

1. After enabling Secret scanning, the option to enable Push protection will
appear. Click **Enable**. ![Enable Push
protection](./images/{EE4585DB-1219-43A3-BDF0-B8E6F0ADCEDB}.png)

---

## Guide de création de dépôt GitHub

Lors de la création d'un dépôt GitHub, vous devez suivre quelques règles de
standardisation organisationnelle :

- Utilisez des lettres minuscules pour nommer votre dépôt. Cela facilite son
utilisation en ligne de commande.
- Utilisez un tiret ( - ) et non un soulignement ( _ ) pour séparer les mots
dans le nom du dépôt.
- Rendez le dépôt public.
- Ajoutez une description.
- Créez un fichier `LICENSE.md`.
- Protégez vos branches.
- Activez la détection des secrets et la protection des poussées.

## Comment créer un fichier LICENSE.md

1. Créez un nouveau fichier et nommez-le `LICENSE.md` :
- ![Créer un fichier
LICENSE.md](https://github.com/ai-cfia/devops/assets/9827730/540c2ee8-fc49-4c76-88c7-115ac8ffcae2)

2. Cliquez sur "Choose a license template."
3. Sélectionnez "MIT License." Toutes les informations nécessaires seront
remplies automatiquement.
- ![Choisir la licence
MIT](https://github.com/ai-cfia/devops/assets/9827730/f7d4576f-1a3e-4a95-98e8-7c67dbd32705)

4. Cliquez sur "Review and submit" pour créer votre fichier.

## Pourquoi protéger vos branches

Protéger les branches dans GitHub est essentiel pour maintenir l'intégrité du
code, garantir un historique de commits cohérent et prévenir les changements
disruptifs. En exigeant des revues de code, en empêchant les poussées forcées et
en requérant un examen minutieux des contributions, la protection des branches
offre une couche fondamentale de sécurité et de contrôle de qualité dans les
projets collaboratifs.

## Comment protéger votre branche

1. Accédez à la page principale de votre dépôt.
2. Cliquez sur l'option "Settings" en haut à droite.
- ![Paramètres](https://github.com/ai-cfia/devops/assets/9827730/5be87238-af3d-4c2c-b17b-8d765f5fbbee)

3. Cliquez sur l'onglet "Branches" dans le menu de droite.
- ![Onglet
Branches](https://github.com/ai-cfia/devops/assets/9827730/5b5d85ef-5713-4c60-a519-6602f86e008a)

4. Assurez-vous de cocher "Require a pull request before merging" et vérifiez
également que "Require approvals" est coché. Vous pouvez laisser l'option par
défaut pour le nombre d'approbations requises.
- ![Paramètres de protection des
branches](https://github.com/ai-cfia/devops/assets/9827730/fe2a4a22-19af-4f3b-96e1-03095c26ddeb)

## Comment activer la détection des secrets et Push Protection

Activer la détection des secrets et le *push protection* dans les dépôts GitHub
aide à éviter l'exposition accidentelle d'informations sensibles, telles que des
clés API, des mots de passe et des jetons, dans votre code. La détection des
secrets identifie les secrets exposés, tandis que le *push protection* bloque
activement les commits contenant des secrets connus. En cas de fuite d'un
secret, les administrateurs du dépôt reçoivent une alerte.

Pour activer ces fonctionnalités :

1. Depuis la page principale de votre dépôt, cliquez sur **Settings**.
![Paramètres du dépôt](./images/{186D1DE0-B70F-4DAA-8267-D8029BB90F66}.png)

2. Dans la barre latérale, faites défiler jusqu'à la section **Security** et
cliquez sur **Code security**.

3. Faites défiler jusqu'à la section **Secret scanning** et cliquez sur
**Enable**.
![Activer la détection des
secrets](./images/{88B79545-E575-41D6-AAB5-EBD53195E25F}.png)

4. Après avoir activé la détection des secrets, l'option pour activer le *push
protection* apparaîtra. Cliquez sur **Enable**.
![Activer le push
protection](./images/{EE4585DB-1219-43A3-BDF0-B8E6F0ADCEDB}.png)

0 comments on commit 4b71be0

Please sign in to comment.