feat: import docsify static website and deploy it to gh pages using gh actions

Author: Donovan1905

.github/workflows/deploy-docsify.yml

@@ -0,0 +1,41 @@
+name: Deploy Docsify to GitHub Pages
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'docs/web-static-doc/**'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # No build step needed for Docsify. Just upload static files.
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/web-static-doc
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/web-static-doc/.nojekyll

@@ -0,0 +1,11 @@
+<!-- # Introduction
+
+Avec IroCO2, simplifiez l'estimation de l'impact carbone de votre infrastructure et accélérez sa transformation pour un cloud plus vert. 🌱
+
+## Vision
+
+Nous souhaitons fournir à travers IroCO2 une solution permettant de simplifier la mise en place d'une démarche GreenOps au sein de vos équipes. 
+
+La démarche peut se résumer à ces quelques mots : **Mesurer**, **Comprendre**, **Agir**.  IroCO2 vise, à travers les différents outils proposés à estimer ou mesurer l'impact carbone de vos solutions et de fournir des analyses et conseils quant à la réduction potentielle de vos impacts. Ces analyses vous permettront par la suite de définir une stratégie GreenOps, de l'implémenter au sein de vos équipes et de vos infrastructures, et enfin de suivre sa réalisation au quotidien sur IroCO2.
+
+IroCO2 ne vise pas à fournir un outil de mesurer le carbone au gramme près. La valeur de nos solutions se trouve dans la possibilité de comparer les estimations selon des changements de configuration techniques sur une infrastructure, et ce dans le but de rechercher une réduction de l'impact carbone. -->

docs/web-static-doc/README.md

@@ -0,0 +1,40 @@
+<style>
+  .error-page {
+    text-align: center;
+    padding: 50px;
+  }
+  .error-page img {
+    width: 300px;
+    height: auto;
+  }
+  .error-page h1 {
+    font-size: 2em;
+    margin-top: 20px;
+  }
+  .error-page p {
+    font-size: 1.2em;
+    margin: 10px 0;
+  }
+  .error-page a {
+    display: inline-block;
+    margin-top: 20px;
+    padding: 10px 20px;
+    background-color: #000;
+    color: #fff;
+    text-decoration: none;
+    border-radius: 5px;
+  }
+</style>
+
+<div class="error-page">
+  <img src="docs/images/404.png" alt="404 Image">
+  <h1>Ooops !</h1>
+  <p>404 - Page not found <span id="path"></span></p>
+</div>
+
+<script>
+  document.addEventListener('DOMContentLoaded', function() {
+    var path = window.location.hash.slice(1);
+    document.getElementById('path').textContent = path;
+  });
+</script>

docs/web-static-doc/_404.md

@@ -0,0 +1,15 @@
+<!-- _coverpage.md -->
+
+<img src="./docs/images/no_bg_white_iroco.png" alt="drawing" width="200"/>
+<link href='https://fonts.googleapis.com/css?family=Inter' rel='stylesheet'>
+
+<div style='color: white; font-family:inter'>
+<h1>IroCO<small>2</small></h1>
+Simplifiez l'estimation de votre empreinte carbone
+</div>
+
+
+[Get Started](#Introduction)
+
+
+![color](#0C1401)

docs/web-static-doc/_coverpage.md

@@ -0,0 +1,3 @@
+<!-- _navbar.md -->
+
+<a href="https://greensuite.ippon.fr">Retourner sur IroCO2</a>

docs/web-static-doc/_navbar.md

@@ -0,0 +1,7 @@
+<!-- docs/_sidebar.md -->
+
+* [Introduction](docs/introduction.md)
+* [Calculatrice carbone](docs/guide_calculatrice.md)
+* [Scanner carbone](docs/guide_scanner.md)
+* [Estimation carbone](docs/estimation_carbone.md)
+* [Roadmap](docs/roadmap.md)

docs/web-static-doc/_sidebar.md

@@ -0,0 +1,68 @@
+# Estimation carbone
+
+## Périmètre de mesure 
+
+Les émissions carbone résultantes de la consommation de services sur le cloud public peuvent être catégorisées en deux types : 
+
+- **La consommation électrique** : C'est le scope 2 du cloud provider, qui correspond au carbone équivalent émis par la production de l'énergie électrique (centrale à charbon, solaire, etc...), consommée par le matériel (serveur, climatiseurs, etc...) pour fournir le service demandé.
+- **La chaîne de valeur du matériel** : C'est le scope 3 du cloud provider, qui correspond au carbone équivalent émis par la fabrication et l'acheminement du matériel utilisé pour fournir le service demandé.
+
+IroCO2 prend actuellement en compte la consommation électrique pour estimer l’empreinte carbone de vos ressources sur le cloud. La prise en compte de la chaîne de valeur pourra y être intégrée quand les sources de données quant au matériel physique utilisé par une ressources cloud ainsi que leur cycle de vie au sein des datacenters seront plus fournies.
+
+## Paramètres de consommation
+
+Afin d’estimer la consommation électrique d’un service consommé sur le cloud, il faut se baser sur différents critères qui sont les suivants.
+
+### CPU : 
+
+L'allocation de CPU sur le cloud se fait à travers la notion de vCPU. Etant donné que l'on peut considérer qu'un cœur d'un CPU physique est égal à un vCPU (dans la virtualisation des ressources matérielles), nous pourrons établir une relation de consommation entre les ressources physiques et virtuelles. 
+
+Il faut ensuite prendre en compte la notion de TDP (Thermal Design Power) qui, selon les constructeurs de CPU, peut être rapproché à la puissance électrique maximale d'un puce processeur. On peut donc en conclure que si un CPU a un TDP de 100W (à 100% de ses capcité), et qu'il est utilisé à 50% de ses capacités, alors il aura une puissance de 50W. Afin de simplifier le calcul dans le cadre de l’Estimateur, nous assumons que le CPU étudié est constamment utilisé à 50% de ses capacité. 
+
+Il n'est pas possible de prévoir à l'avance avec exactitude quel modèle de processeur sera alloué par le cloud provider à votre ressource. Il existe tout de même un moyen de faire la disctinction entre les processeurs en amont d'un déploiement afin d'éco-concevoir vos infrastructures cloud. Pour cela, nous nous basons sur le type d'architecture CPU qui fait fortement varier le TDP moyen. Par exemple, les processeurs de type ARM aurons en moyenne un TDP bien plus bas que les type x86.
+
+En reprenant tous ces élements, on peut estimer la consommation électrique d'un ensemble de vCPUs alloués à une ressource sur le cloud public avec la formule suivante :
+
+![Formule de la consommation électrique pour les vCPUs](./images/formule_vcpu_kwh.png)
+
+### Mémoire :
+
+Nous utilisons les constantes de consommation électrique de l’étude [Etsy Cloud Jewels](https://www.etsy.com/codeascraft/cloud-jewels-estimating-kwh-in-the-cloud).  
+
+### Stockage :
+
+Nous utilisons les constantes de consommation électrique de l’étude [Etsy Cloud Jewels](https://www.etsy.com/codeascraft/cloud-jewels-estimating-kwh-in-the-cloud).   
+
+### GPU : 
+
+Afin d'estimer la consommation électrique d'une carte GPU, nous nous basons sur les mêmes principes que le calcul du CPU, à l'exception que nous prenons en compte la totalité du GPU, il n'y a donc pas de notion de vGPU dans notre cas d'étude.
+
+## Mix énergétique
+
+Le mix énergétique d'un pays ou d'une région réprésente la répartition des différents types d' production d'énergie dans la zone. Cette répartition permet de déterminer le coût carbone de l'énergie consommée à cet endroit, exprimé en gCO2eq / kWh.
+
+C'est avec cette donnée que nous sommes en capacité d'estimer l'empreinte carbone de l'énergie consommée pour vos activités sur le cloud. Par exemple, si vos ressources déployées en France consomment 50 kWh et étant donné le coût carbone de l'énergie française d'environ 30 gCO2eq pour 1 kWh, alors l'empreinte carbone de l'utilisation de ces dernières sera de 1,5 kg CO2eq.
+
+## Limitations
+
+Voici une liste de paramètres généraux que nous ne prenons pas en compte pour le moment : 
+
+- Consommation électrique du trafic réseau
+- PUE des datacenters AWS (non fournis)
+- Réplications non exhaustives des ressources
+- Pas de différenciation entre les différents modèle de processeurs Graviton
+- Pas de différenciation entre les types de stockages (HDD, SSD, etc...)
+
+Vous pouvez retrouver, et pour chacun des services cloud compatibles avec IroCO2, les limitations précises (prise en compte partielle du service, manque de données, etc...).
+
+## Sources
+
+Cloud Jewels : Estimating kwh in the cloud : https://www.etsy.com/codeascraft/cloud-jewels-estimating-kwh-in-the-cloud
+
+Cloud Carbon Footprint : Methodology : https://www.cloudcarbonfootprint.org/docs/methodology/
+
+Microsoft : How can I calculate co2eq emissions for my Azure VM? : https://devblogs.microsoft.com/sustainable-software/how-can-i-calculate-co2eq-emissions-for-my-azure-vm/
+
+Intel : Processor specifications and compatibility : https://www.intel.com/content/www/us/en/support/articles/000055611/processors.html
+
+AWS Documentation (physical specification of services, replication, ...) : https://docs.aws.amazon.com/

docs/web-static-doc/docs/estimation_carbone.md

@@ -0,0 +1,26 @@
+# Calculatrice carbone
+
+## Créer une infrastructure
+
+Sur votre espace utilisateur, rendez-vous sur *Mes infrastructures*, puis choissisez *Nouvelle Infrastructure*. Configurez ensuite votre infrastructre en choisissant un nom, un cloud provider parmis ceux compatible avec IroCO2 ainsi qu’une région par défault sur laquelle vous souhaitez configurer vos composants.
+
+![New infra page](./images/create_infrastructure.png)
+
+## Ajouter des composants 
+
+Afin de représenter les ressources cloud qui sont ou serons présents sur votre infrastructure,  il faut créer des composants qui reprènne les éléments de configuration d’une ressource (vCPUs, mémoire, stockage, etc...), ainsi que des éléments de configuration sur son usage (temps d’utilisation, réplication, etc...). Vous pouvez si vous le souhaitez configurer un comosant une région alternative à celle par défaut de votre infrastrucure.
+
+Sur le *concepteur d'infrastructure*, selectionner *Nouveau composant* et choisissez le service à configurer (par exemple : EC2, Lambda, etc...).
+
+## Estimer l'empreinte 
+
+L'estimation carbone d'une infrastructure va vous permettre d'avoir accès aux informations suivantes :
+
+- **Prévision d'empreinte carbone mensuelle** : Une masse CO2eq prévue sur une période de un mois
+- **Une aide à la comparaison** : Il sera plus facile de se rendre compte pour vos équipes de l'ampleur de l'impact carbone des changements apportés à vos infrastructures avec des rapprochements à des actions du quotidien (déplacements en voiture/avion, chauffage, etc...)
+- **Un classement des ressources les plus émétrices** : Pour mieux concentrer vos effort d'amélioration
+- **Des propositions de régions alternatives** : Une comparaison des régions proches en fonction de la différences financières et environnemental pour vous aider dans les décisions de migration.
+
+## Réduire son empreinte 
+
+Pour chacun des services cloud compatible avec IroCO2, vous pouvez vous référer au *Catalogue de disponibilité* pour y trouver des leviers d’actions permettant de commencer à éco-concevoir votre infrastructure et réduire son empreinte carbone.