Skip to content
Snippets Groups Projects
Verified Commit a14baac0 authored by Geoffrey Arthaud's avatar Geoffrey Arthaud
Browse files

ci: :zap: Use CI component

parent 29a5cf34
No related branches found
No related tags found
1 merge request!1Utiliser un component CI
Pipeline #426503 failed
# Ce fichier définit le comportement CI/CD souhaité
image: python:3.9.13-bullseye # Image Docker offrant un environnement Python installé sur une Debian 11 (bullseye)
#variables:
# The runner will pull the runner helper image from registry.gitlab.com :
#FF_GITLAB_REGISTRY_HELPER_IMAGE: 1
before_script:
# Installation des prérequis techniques
- pip install -r requirements.txt
stages:
- test
- deploy
# ✔️ Phase de vérification de la bonne construction du site
test-building-site-documentation-NumEcoEval-quickstart:
stage: test
script:
- echo ""
- echo "Test de construction du site hébergeant la documentation"
# le site est construit dans le répertoire "site-documentation-quickstart"
- mkdocs build --verbose --site-dir site-documentation-quickstart
artifacts:
paths: # Liste des élements à intégrer dans l'artefact
- site-documentation-quickstart
expire_in: 1 week
only:
- main
except:
changes:
- README.md
# 🚀 Phase de déploiement du site, effectuée uniquement si la phase de test est concluante
pages: # Le résultat de ce job est utilisé par les "GitLab Pages"
stage: deploy
script:
- echo ""
- echo "Déploiement du site hébergeant la documentation du Quickstart de NumEcoEval"
# le site est construit dans le répertoire par défaut "public"
- mkdocs build --verbose
artifacts:
paths:
- public
expire_in: 1 week
only:
- main
except:
changes:
- README.md
include:
- component: $CI_SERVER_FQDN/share/components/dsfr-docs/dsfr-docs@~latest
# NumEcoEval quickstart
## Objectif du projet
Ce projet a été instancié pour permettre la mise en place de la documentation de l'offre Dataviz / Superset.
Techniquement, la documentation s'appuie sur les GitLab Pages et repose sur des fichiers Markdown.
Le résultat est visible à l'adresse suivante : [ds/gd3ia/dataviz_superset sur GitLab pages](https://snum.gitlab-pages.din.developpement-durable.gouv.fr/ds/gd3ia/offre-dataviz-documentation)
Le thème utilisé est material car il offre le meilleur rendu
- [x] Affichage des pages
- [x] Affichage de la navigation
- [x] Recherche possible
- [x] Affichage des citations (info, warning, etc...)
- [x] Coloration syntaxique du code
- [x] Copie en un clic du code
- [x] Génération du PDF (avec les blocs de code et le accordéons bien restitués)
- [x] Affichage des éléments accordéon de la FAQ
Il est conseillé d'utiliser le format Markdown au sens strict pour ne pas mélanger du HTML à la syntaxe basique reposant sur les balises suivantes :
## Les balises de Titre
```md
# Titre de niveau 1
```
# Titre de niveau 1
```md
## Titre de niveau 2
```
## Titre de niveau 2
```md
### Titre de niveau 3
```
### Titre de niveau 3
## Les balises de formatage de texte
```md
**Texte en gras**
```
**Texte en gras**
```md
_Texte en italique_
```
_Texte en italique_
```md
~~Texte barré~~
```
~~Texte barré~~
```md
> Citations
```
> Citations
## Les balises de bloc
```md
`Bloc de code simple`
```
`Bloc de code simple`
~~~md [comment]: <> (Ici, on utilise la variante de définition du bloc basé sur le tilde car le bloc contient un autre bloc)
```json
{
"objet": "bloc de code",
"rendu": "coloration syntaxique activée (json)",
"note": 20
}
```
~~~
```json
{
"objet": "bloc de code",
"rendu": "coloration syntaxique activée (json)",
"note": 20
}
```
```md
- Elément de la liste
- Autre élément de la liste
```
- Elément de la liste
- Autre élément de la liste
_Ne pas utiliser les listes nuémrotées car mal retranscrites en PDF_
```md
| header | header |
| ------ | ------ |
| cell | cell |
| cell | cell |
```
| header | header |
| ------ | ------ |
| cell | cell |
| cell | cell |
## Les balises de liens
```md
[texte](url)
```
[texte](url)
```md
![texte_image](url_image)
```
![texte_image](url_image)
## Les commentaires
```md
[comment]: <> (1ère ligne de commentaire)
[comment]: <> (2ème ligne de commentaire)
[comment]: <> (3ème ligne de commentaire)
```
[comment]: <> (1ère ligne de commentaire)
[comment]: <> (2ème ligne de commentaire)
[comment]: <> (3ème ligne de commentaire)
\ No newline at end of file
- [Documentation au format DSFR](https://quickstart-pub-numeco-m4g-manuel-utilisateur-cc30f193ca702ad555.gitlab-pages.din.developpement-durable.gouv.fr/)
- [Wiki pour modifier les pages](https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/m4g/manuel-utilisateur/quickstart/-/wikis/)
- [Pour déployer le contenu du wiki](https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/m4g/manuel-utilisateur/quickstart/-/pipelines/new) -> puis cliquer sur le bouton "Run pipeline"
> ⚠️ **Travail en cours** ⚠️
## Début de documentation
- Le titre du site et le sous-titre reprennent directement le titre du projet Gitlab et sa description
- Toujours utiliser du markdown dans le wiki
- Possibilité d'inclure des images externes
- On peut utiliser l'insertion des diagrammes du wiki (qui fabrique un svg qui est ensuite importé comme image)
- Le menu latéral du wiki Gitlab devient le menu principale de navigation en DSFR. Seuls les liens avec titre vers les pages internes au Wiki sont pris en compte.
- Il est possible d'avoir un menu sur deux niveaux à condition que :
- La barre latérale se présente comme une liste à puces
- Les sous-menus ont une indentation (série d'espaces) en début de ligne
- Le menu englobant les sous-menus est juste un texte et non un lien
- Exemple :
```markdown
- [Accueil](Home)
- Documents
- [Mode d'emploi](Mode-d'emploi)
- [Local Document](Local-Doc)
- [Autre lien](Sample-Markdown)
```
## Déploiement
`Build -> Pipelines -> Run pipeline en haut à droite`
# Nom du site
site_name: Documentation de NumEcoEval quickstart
# Emplacement des fichiers markdown du site
docs_dir: ./docs
theme:
name: material # Autres rendus possible : readthedocs, mkdocs, etc...
language: fr
features:
- content.code.copy # Pour permettre la copie en un clic des morceaux de code
site_url: https://snum.gitlab-pages.din.developpement-durable.gouv.fr/etc
# Répertoire stockant l'artefact du site
site_dir: public
# Navigation du site
nav:
- Introduction: 'index.md'
- Utiliser la version en ligne (SaaS):
- Se connecter: 'Seconnecter.md'
- Choisir son ojectif: 'Objectif.md'
- Calculer l'impact d'un Système d'Information: 'ImpactSI.md'
- Calculer l'impact d'un Service Numérique: 'ImpactSN.md'
- Déployer l'outil en interne (On-premise):
- Package à télécharger: 'Package.md'
- Etapes de déploiement: 'Etapes.md'
- Problèmes récurrents: 'Problemes.md'
- Ajout de Superset: 'Superset.md'
- Comprendre les résultats:
- L'analyse du cycle de vie: 'ANCV.md'
- Les 5 critères d'impact: '5criteres.md'
- Lire les résultats: 'Lire.md'
- Interprétrer les résultats:
- Vos résultats et les seuils: 'Seuils.md'
- Les possibles conclusions: 'Conclusions.md'
- Faire des simulations: 'Simulations.md'
- Exemples de leviers:
- Rappel des lois et réglementations: 'Lois.md'
- Avant l'achat: 'AvantAchat.md'
- Vers un achat durable: 'PendantAchat.md'
- Vers un usage durable: 'UsageDurable.md'
- Le réemploi: 'Reemploi.md'
- Le reconditionnement et les D3E: 'Reconditionnement.md'
- FAQ: 'FAQ.md'
- Notes de version: 'NotesdeVersion.md'
plugins:
# Ajout de la recherche
- search:
lang: fr
# Génération d'une version PDF du site
- with-pdf:
author: TEST TEST
copyright: © MTE
# Page de couverture
cover: true
cover_logo: ./images/wip.jpg
cover_title: Documentation quickstart de NumEcoEval
cover_subtitle: (NumEcoEval x g4it x superset)
# Table des matières
toc_title: Table des matières
# Corps du document - Exclusion de la page d'accueil (car utile uniquement pour le site)
exclude_pages:
- ^$
# Quatrième de couverture
back_cover: true
# Chemin de stockage
output_path: pdf/doc_NumEcoEval_quickstart.pdf
# Extensions
markdown_extensions:
# Ajout pour les diagrammes Mermaid
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# Ajout pour la coloration syntaxique des morceaux de code
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
\ No newline at end of file
# Générateur de la documentation
mkdocs>=1.1.2
# Thème (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes)
mkdocs-material>=5.4.0
# Générateur de documents PDF
mkdocs-with-pdf
# Pour intégrer un qrcode à la dernière page du PDF
qrcode
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment