Initialisation du repo de documentation de NumEcoEval (Quickstart)

33498c0e · RICO_Octo · 2180df4e · 33498c0e · 33498c0e · 33498c0e
Commit 33498c0e authored 8 months ago by RICO_Octo
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
-pages:
+# 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-dataviz:
+  stage: test
+  script:
+    - echo ""
+    - echo "Test de construction du site hébergeant la documentation"
+    # le site est construit dans le répertoire "site-documentation-dataviz-test"
+    - 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:
-    - mkdir .public
+    - echo ""
-    - cp -r * .public
+    - 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
+    - public
\ No newline at end of file
+    expire_in: 1 week
+  only:
+    - main
+  except:
+    changes:
+      - README.md
--- a/README.md
+++ b/README.md
-# quickstart
+# Dataviz_superset
-## How does it works
+## Objectif du projet
-Create .md files, commit and push.
+Ce projet a été instancié pour permettre la mise en place de la documentation de l'offre Dataviz / Superset.
-check exposition at:
+Techniquement, la documentation s'appuie sur les GitLab Pages et repose sur des fichiers Markdown.
-https://<namespace>.gitlab.io/<project_slug>
+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)
-## Getting started
+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
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+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 :
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+## Les balises de Titre
-## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+```md
+# Titre de niveau 1
 ```
-cd existing_repo
+# Titre de niveau 1
-git remote add origin https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/m4g/manuel-utilisateur/quickstart.git
-git branch -M main
-git push -uf origin main
-```
-## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/m4g/manuel-utilisateur/quickstart/-/settings/integrations)
-## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-## Test and Deploy
-Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-***
-# Editing this README
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-## Name
-Choose a self-explaining name for your project.
-## Description
+```md
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+## Titre de niveau 2
+```
-## Badges
+## Titre de niveau 2
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-## Usage
+```md
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+### Titre de niveau 3
+```
+### Titre de niveau 3
-## Support
+## Les balises de formatage de texte
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-## Roadmap
+```md
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+**Texte en gras**
+```
+ **Texte en gras**
-## Contributing
+```md
-State if you are open to contributions and what your requirements are for accepting them.
+_Texte en italique_
+```
+ _Texte en italique_
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+```md
+~~Texte barré~~
+```
+ ~~Texte barré~~
+```md
+> Citations
+```
+> Citations
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+## Les balises de bloc
-## Authors and acknowledgment
+```md
-Show your appreciation to those who have contributed to the project.
+`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 |
-## License
+## Les balises de liens
-For open source projects, say how it is licensed.
-## Project status
+```md
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+[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
--- a/docs/.gitkeep
+++ b/docs/.gitkeep
--- a/docs/images/.gitkeep
+++ b/docs/images/.gitkeep
--- a/docs/images/wip.jpg
+++ b/docs/images/wip.jpg
--- a/docs/index.md
+++ b/docs/index.md
+# Bienvenue sur la documentation NumEcoEval QuickStart
+![logo_offre.png](./images/wip.jpg)
+Ce site hébèrge la documentation relative à l'offre NumEcoEval, aussi consultable au [format PDF 📖](./pdf/exemple.pdf).
\ No newline at end of file
--- a/docs/pdf/.gitkeep
+++ b/docs/pdf/.gitkeep
--- a/docs/pdf/Readme.md
+++ b/docs/pdf/Readme.md
+Le fichier PDF **exemple** n'est pas la dernière version générée automatiquement.
+Il est présent dans cette arborescence pour éviter un avertissement lors de la génération du site (un lien pointe vers la documentation PDF)
--- a/docs/pdf/exemple.pdf
+++ b/docs/pdf/exemple.pdf
--- a/mkdocs.yml
+++ b/mkdocs.yml
+# 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:
+  - Accueil: 'index.md'
+  - Offre : 'votre fichier.md'
+  - Autre : 'un autre fichier.md'
+plugins:
+  # Ajout de la recherche
+  - search:
+      lang: fr
+  # Génération d'une version PDF du site
+  - with-pdf:
+      author: Pauline ROBIC
+      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/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
--- a/requirements.txt
+++ b/requirements.txt
+# 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