Le système de documentation du pôle serveur est conçu pour permettre la délégation et la durabilité des connaissances du pôle serveur de l'IsenEngineering.

L'idée c'est que cette documentation reste publique afin que ceux qui souhaitent apprendre puissent s'appuyer sur une ressource et apprendre des erreurs passées également.

Cette documentation est facile d'accès, peut être mise à jour régulièrement assez simplement et ne coûte rien à hébérger.

Voici les étapes à suivre pour que vos modifications soient prises en compte.

Fork le répértoire,
Cela va créer une copie de code sur votre compte github.

Créer une nouvelle branche avec le nom de votre modification,
Vous pourrez alors faire les modifications que vous souhaitez librement.

Enfin vous devrez proposer une pull request sur le repo.

Nous vous prions de bien indiquer quels changements / modifications vous avez apporté dans les encadrés à cet effet. Exemple: "title of the pull request" -> il faut écrire qu'est-ce que vous proposez, fix/feat/doc/... avec un titre

Le responsable se mettra alors à revoir vos modifications afin de corriger de potentiels erreurs ou autre. Enfin votre changement sera merged, ajouté au code source principal!

Chaque document devront également être téléversé sur le drive des responsables dans le répértoire du pôle.

Cette documentation utilise gohugo, c'est rapide et efficace. Au lieu d'installer golang et hugo, j'ai mis des images docker à disposition pour éviter d'avoir à installer puis désinstaller des dépencences et pour éviter des problèmes de compatibilités.

# On clone le code dans son environnement
git clone https://github.com/isenengineering/serveur.git
cd ./serveur
# On démarre le serveur de développement avec gohugo
#  - on lie le répértoire courant avec le conteneur
#  - on expose le port 1313 du conteneur
docker run -it -v .:/doc-ie -p 1313:1313 ghcr.io/isenengineering/serveur:dev

# On démarre le serveur de production avec un serveur http
#  - le site est généré à la construction de l'image
#  - le port à l'intérieur de l'image est 6880 
#    et 80 à l'extérieur (vous pouvez changer le port extérieur)
docker run -it -p 80:80 ghcr.io/isenengineering/serveur

Pour générer les images vous pouvez suivre ces guides

# Construction de l'image du serveur de développement 
# (darkhttpd + site ~500ko)
docker build -f build.Dockerfile -t ghcr.io/isenengineering/serveur .

# ou en précisant la plateforme (ex: linux/amd64, linux/arm64...)
docker buildx build --platform linux/amd64 -f build.Dockerfile -t ghcr.io/isenengineering/serveur .

# Construction de l'image du serveur de développement 
# (go + hugo + git ~300mo)
docker build -f dev.Dockerfile -t ghcr.io/isenengineering/serveur:dev .

# ou en précisant la plateforme (ex: linux/amd64, linux/arm64...)
docker buildx build --platform linux/amd64 -f dev.Dockerfile -t ghcr.io/isenengineering/serveur:dev .

# Le serveur de production
docker push ghcr.io/isenengineering/serveur

# Le serveur de développement
docker push ghcr.io/isenengineering/serveur:dev