From 3e3cd7ee16cdfdd5eba0b3120ee6501183d8e65a Mon Sep 17 00:00:00 2001 From: Simon C Date: Mon, 13 Mar 2023 09:38:06 +0100 Subject: [PATCH] feat(Docs): Remove old documentation --- README.md | 59 ++++++++++++++++++++++++++++++++++--------------------- run | 24 ---------------------- 2 files changed, 37 insertions(+), 46 deletions(-) delete mode 100755 run diff --git a/README.md b/README.md index 2442604..a0994d4 100644 --- a/README.md +++ b/README.md @@ -6,26 +6,52 @@ Le but étant de communiquer et se faire connaître sur nos différentes offres ## Technologie -- Le site est créé à l'aide de l'outil de génération de site statique Open Source [Hugo](https://gohugo.io). -- Le serveur web utilisé est [Nginx](https://www.nginx.com/) -- La mise à jour s'éffectue avec [Directus](https://directus.io/) -- Le déploiement à l'aide de docker compose (v2) +- Le site est créé à l'aide de l'outil de génération de site statique Open Source [Hugo](https://gohugo.io) +- Le déploiement continu se fait à l'aide de l'outil Open Source [Drone CI](https://www.drone.io/) +- Le site est hébergé sur un stockage S3 dont l'outil est [Garage](https://garagehq.deuxfleurs.fr/) fait par l'association [Deuxfleurs](https://deuxfleurs.fr/) +- Une gestion de haute disponibilité est mis en place à l'aide de [Traefik](https://traefik.io/) ## Commandes -Il y a plusieurs commandes que vous pouvez visualiser à l'aide de la commande `./run`. +### Initialisation Voici les commandes pour démarrer le projet localement : + ``` -git clone --recurse-submodules https://git.weko.io/resilien/resilien.fr.git -cd resilien.fr -./run install -./run dev +git clone --recurse-submodules https://git.resilien.fr/ResiLien/resilien.git +cd resilien ``` -Pour déployer en production : +Il faut ensuite installer quelques paquet depuis NPM : + ``` -./run prod +(cd themes/hugo-theme-lowtech && npm i) +``` + +### Développement + +Il faut lancé le serveur de Hugo : + +``` +hugo serve +``` + +### Déploiement + +Pour déployer sur _staging_ : + +``` +hugo --minify --buildDrafts --buildFuture --environment staging +node themes/hugo-theme-lowtech/scripts/typo +hugo deploy --environment staging +``` + +Pour déployer en _production_ : + +``` +hugo --minify --environment production +node themes/hugo-theme-lowtech/scripts/typo +hugo deploy --environment production ``` ## Liens @@ -36,14 +62,3 @@ Pour déployer en production : Icons : - Prise de note : https://thenounproject.com/search/?q=writting&i=3039563 - Partage de fichiers : https://thenounproject.com/designcircle41/collection/data-storage/?i=4288373 - -## Favicon - -Il a été fait avec l'outil en ligne https://formito.com/tools/favicon et sauvegarder dans /static/logo.svg : -- Letter : R -- Font : Ubuntu -- Size : 90 -- Variant : 500 -- Background : carré avec les coins arrondis de couleur #c14508 - -Pour générer le favicon.ico `./run favicons` diff --git a/run b/run deleted file mode 100755 index bf27f5c..0000000 --- a/run +++ /dev/null @@ -1,24 +0,0 @@ -#!/bin/bash - -# -e Exit immediately if a command exits with a non-zero status. -# -u Treat unset variables as an error when substituting. -set -eu - -. ./.env -. ./themes/hugo-theme-lowtech/scripts/run - -echo " ____ _ _ _ " -echo "| _ \ ___ ___(_) | (_) ___ _ __ " -echo "| |_) / _ \/ __| | | | |/ _ \ '_ \ " -echo "| _ < __/\__ \ | |___| | __/ | | |" -echo "|_| \_\___||___/_|_____|_|\___|_| |_|" -echo -echo - -if [ $# -ge 1 ]; then - $@ -else - help_generic -fi - -end