Skip to content

Contribuer à cette page web#

Cette page internet exploite directement la section "Documentation" du dépot GitLab. Elle fonctionne grâce aux ressources Mkdocs et à Material. Il est nécessaires de suivre quelques étapes pour contribuer.

Prérequis#

Il est possible que GitLab vous demande de devenir un membre "certifié" pour pouvoir intervenir sur la page web. Celle-ci exploite les pipelines (les tuyaux), un mécanisme de Git qui permet d'avoir des étapes de validation notamment pour in fine développer une page Web. La pipeline permets notamment, lorsqu'un changement corrompu est envoyé sur le dépot, de rendre invalide ce changement et de ne pas l'envoyer sur la page web. GitLab vous demandera vos coordonnées bancaires afin de certifier que vous êtes un utilisateur unique (et de limiter le minage de cryptomonnaies).

Installer les ressources#

Il est nécessaire d'avoir Python d'installé (la dernière version).
Ensuite il est nécessaire d'installer "pip". Pour cela il faut aller sur votre console (cmd) et coller ceci.

py -m ensurepip --upgrade

Attention : Il est nécessaire que votre variable d'environnement Python soit bien paramétrée.

Développer le serveur local de test#

Ensuite, on peut utiliser "pip". IL faut d'abord depuis le panneau de commande (cmd) déclaré le chemin du répertoire avec la commande cd :

cd C:\Users_\...\Documents\GIT\OCARHY\documentation

Ensuite, il est alors possible de créer un serveur en local ce qui vous évitera d'envoyer vos tests directement sur la page web officielle.

mkdocs serve

Structurer la page#

3 éléments permettent de faire fonctionner la page :

  • Un fichier yaml : mkdocs.yml
  • Un fichier yaml : .gitlab-ci.yml
  • Des fichiers md : index.md ...

Le Yaml ?

Le Yaml (.yml), c'est un format texte comme le csv qui permet de gérer des fonctionnalités lié notamment à la mise en forme web et des flux.

Le contenu de : mkdocs.yml#

Le mkdocs.yml permets d'exploiter toutes les ressources de mkdocs (ca décrit les dépendances).

Dans ce fichier on copie-colle ceci :

theme:
  name: material  
site_name : OCARHY</code>

Le contenu de : .gitlab-ci.yml#

C'est ce qui fait tilter à Gitlab qu'une pages est demandée. C'est la ressource permettant de déployer la page.

image: python:latest
pages:
  stage: deploy
  only:
    - main
  script:
    - pip install mkdocs-material
    - mkdocs build --site-dir public
  artifacts:
    paths:
    - public

Le contenu de index.md#

C'est le contenu texte et sa mise en forme sur la page web (fonctionne avec la syntaxe MarkDown)

Pour aller plus loin

Back to top