Aller au contenu

Création d'une revue de presse#

icône news générique

La création d'une revue de presse passe par la création d'une branche dédiée dans le dépôt du site et du fichier Markdown qui contiendra les news dans une structure type. Il est possible de créer en utilisant Git en ligne de commande ou via l'interface web de GitHub.

TL;DR : voici une vidéo retraçant les étapes de création d'une revue de presse via l'interface web de GitHub :


Créer la branche de la revue de presse#

logo Git

La première étape consiste à créer une branche Git pour la revue de presse. Elle n'est réalisable que par une personne disposant d'un compte GitHub ayant les droits en écriture sur le dépôt du site : geotribu/website.

Il est important de respecter la convention de nommage rdp/YYYY-MM-DD où :

  • YYYY est l'année de publication
  • MM le mois de publication prévisionelle
  • DD le jour de publication prévisionnelle

Exemple si la GeoRDP devait être publiée le 17 septembre 2021 : rdp/2021-09-17.

GitHub#

Sur l'interface web du dépôt :

  1. Se positionner sur la branche master
  2. Dans le menu déroulant de sélection des branches, entrer le nom de la nouvelle branche
  3. Cliquant sur Create branch: rdp/2021-09-17 from 'master'.

Github - New branch

Ligne de commande#

Si vous disposez du dépôt localement et que vous préférez utiliser la ligne de commande de Git, voici les étapes à suivre :

  1. Mettre à jour le dépôt local :

    1
    git pull
    
  2. Vérifier qu'une branche n'existe pas déjà en listant les branches du dépôt sur GitHub en filtrant sur la structure de nommage :

    1
    git branch -r -l 'origin/rdp/*'
    
  3. Créer la nouvelle branche :

    1
    2
    $ git checkout -b rdp/2021-09-17
    Switched to a new branch 'rdp/2021-09-17'
    
  4. Pousser la branche sur GitHub :

    1
    2
    3
    4
    5
    6
    7
    8
    $ git push origin rdp/2021-09-17
    Total 0 (delta 0), réutilisés 0 (delta 0), réutilisés du pack 0
    remote:
    remote: Create a pull request for 'rdp/2021-09-17' on GitHub by visiting:
    remote:      https://github.com/geotribu/website/pull/new/rdp/2021-09-17
    remote:
    To github.com:geotribu/website.git
    * [new branch]        rdp/2021-09-17 -> rdp/2021-09-17
    

Créer le fichier de la revue de presse#

icône globe tricot

Afin d'accueillir les news, il s'agit de créer un fichier en respectant l'organisation et le nommage des fichiers : content/rdp/YYYY/rdp_YYYY-MM-DD.md où :

  • YYYY est l'année de publication
  • MM le mois de publication prévisionelle
  • DD le jour de publication prévisionnelle

Exemple si la GeoRDP devait être publiée le 17 septembre 2021 : content/rdp/2021/rdp_2021-09-17.md.

Structure type et modèle#

Les revues de presse sont structurées de la même façon d'une édition à l'autre, facilitant leur consultation et les traitements automatiques. Le plus simple est donc de copier/coller la structure type à partir du modèle maintenu à jour :

soit depuis le PAD soit depuis GitHub

Ensuite, il faut mettre à jour certains éléments :

  • dans l'en-tête du fichier, mettre à jour les valeurs de title:, date: et description: (notamment la date)
  • changer la date dans le titre de niveau 1

Les lignes concernées sont surlignées ci-dessous (attention, cela peut varier selon le modèle utilisé) :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
---
title: "[TEMPLATE] Revue de presse du 21 août 2021"
authors:
    - Geotribu
categories:
    - revue de presse
date: 2021-08-21 14:20
description: ""
image: "URL de l'image d'illustration de la RDP"
license: default
tags:
    - tag 1
    - tag 2
    - ...
---

# Revue de presse du 21 août 2021

## Intro

![icône news générique](https://cdn.geotribu.fr/img/internal/icons-rdp-news/news.png "icône news générique"){: .img-rdp-news-thumb }

[Commenter cette revue de presse :fontawesome-solid-comments:](#__comments){: .md-button }
{: align=middle }

Pousser le fichier sur GitHub#

Enfin, il faut pousser le fichier sur la branche créée sur GitHub.

GitHub Desktop#

TO DOC

Ligne de commande#

1
git add content/rdp/2021/rdp_2021-09-17.md

  1. analogie avec un cadre légal qui repose sur un usage raisonnable des oeuvres et ressources. Voir la fiche Wikipedia

  2. étape où un contributeur propose d'intégrer ses modifications dans le socle principal du projet. Voir la documentation de GitHub


Dernière mise à jour: 9 octobre 2021
Créé: 28 septembre 2021
Contributions à cette page : Julien Moura

Ce contenu est sous licence Creative Commons BY-NC-SA 4.0 International


Commentaires

Une version minimale de la syntaxe markdown est acceptée pour la mise en forme des commentaires.
Propulsé par Isso.
Retour en haut de la page