Skip to content

CQEN-QDCE/ceai-cqen-web-platform

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

img License


Plateforme d'accueil du CEAI

La plateforme d' accueil Web du Centre d'Expertise Appliquée en Innovation du CQEN (CEAI) est un site statique développé en Ruby avec Jekyll, déployé sur AWS S3 et exposé avec AWS CloudFront.

Site

Objectif

La plate forme web du CEAI donne un apperçu sur les activités ainsi que les services qu'offre l'équipe d'innovation dont:

  • Le laboratoire d'expérimentation sur ses plateformes AWS SEA et Openshift. Ceci est un concept représentant l’ensemble des ressources nécessaires à la réalisation d’une expérimentation, cela inclut les environnements de développements, les usagers, les environnements de déploiements, la documentation, etc.

Prérequis

  • Avoir un poste Linux ou MacOs
  • Avoir visual studio code installé sur le poste (facultatif)

Installation:

Étapes pour héberger le site localement:

  1. Cloner le projet.
  2. Faire la commande git submodule init pour initialiser le submodule dans votre répertoire local, puis git submodule update pour pull la dernière version du submodule.
  3. Installez ruby v3.0.4 ou + sur votre poste Suivre la procédure d'installation
  4. Exécutez la commande suivante pour installer les gem nécessaires à la plateforme web bundler install
  5. Exécutez la commande suivante pour démarrer le serveur bundle exec jekyll server

Contenu

Explication des dossiers

  • _layouts : fichiers html faisant office de template, un layout est le html qui englobe le contenu d'une page, plusieurs layouts peuvent être utilisés l'un dans l'autre
  • _include : layouts imbriqués dans ceux plus généraux dans - _layouts :
  • _posts : fichiers markdown contenant certains paramètres et son contenu, ce sont les articles qui seront utilisés et listés sur le site
  • _sass : scss disponible du site et des thèmes
  • .github/workflow : contient les paramètres de build pour github pages, notamment quel token utiliser
  • assets : (à vérifier) contient les contenus multimédia du site ainsi que les feuilles de style utilisées, le css généré par le css se retrouvera dans ce dossier lors du build
  • _site : (généré lors d'un push) site résultant du build

Précision sur la création des pages avec Jekyll:

Pour s'assurer que le liens hypertexte soit généré d'une manière compatible avec le service de site static S3, il faut:

  • Ajouter dans le fichier nom-de-la-page.markdown qui se trouve dans le dossier _pages un permalink: /nom-de-la-page/index.html ce qui va générer automatiquement un nouveau fichier nom-de-la-page/index.html dans le dossier _site.

Pour mettre à jour le submodule (contenu du site):

git submodule update --remote

Déploiement en production

Le pipeline de deploement sur AWS est démarré par :

  • Un Github Pull Request se faisant accepter sur la branche main OU tout autre push sur la branche main.

  • Vous pourrez voir le processus en cours d'exécution et voir les détails de chaque étape d'exécution en cliquant sur le pipeline sur le console AWS.

  • Voici le lienpour que vous puissiez voir les processus de provisionnement de l'environnement sur AWS et tous les détails de l'architecture

Références:

About

Plateforme d'accueil Jekyll du laboratoire d'innovation

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published