Skip to content

Latest commit

 

History

History
140 lines (103 loc) · 5.02 KB

CONTRIBUTING.md

File metadata and controls

140 lines (103 loc) · 5.02 KB
Raw

Contribuer au blog Duchess

Contribuer au blog sans rien installer (GitPod)

Ouvrir dans Gitpod

Ouvrir GitPod, dans le terminal, suivre le lien avec un ctrl + click (ou command + click) sur http://localhost:4000

Ecrire un post dans le blog

Pre-requis

Pour proposer un nouveau post

Remarque: La Core Team Duchess est responsable de la ligne éditoriale, il est préférable de contacter une des membres de la Core Team, soit sur Slack, soit sur twitter, soit par e-mail afin de partager le thème du post que vous souhaitez rédiger.

Cloner un fork du depôt de source git en local

  • Faire un fork du repo (via le bouton "fork" en haut à droite)
  • Cloner le fork sur votre PC (vous pouvez copier/coller la ligne de commande donnée par github sur le bouton "Code")
  • créer une branche avec un nom (changez "mabranche"):
git checkout -b mabranche

Préparer les fichiers nécessaires

Les répertoires interessants dans l'arborescence sont:

- docs: base du site
--_authors: répertoire contenant les bios des autrices
--_post: répertoire contenant le texte des posts
--assets: répertoire contenant les images

  1. créer nouveau fichier markdown dans le dossier docs/_posts avec un nom qui commence par la date approximative de publication du post au format YYYY-MM-dd. Vous pouvez vous inspirer des posts existants dans le même dossier.

  2. Compléter la partie "meta" dans le fichier markdown en en-tête:

---
layout: "post"
title:  "Féminiser son équipe de développement"
date:   "2021-05-12"
categories: f
    - "feminisme"
author: 
    - "angelique"
---
  • layout: ne peut être que "post"
  • title: Votre titre de post
  • date: la même que celle dans le nom de fichier
  • categories: (facultatif) vous pouvez en utiliser une existante ou en créer une nouvelle
  • author: votre pseudo (le nom du fichier contenant votre biographie dans /docs/_authors/ mais sans l'extension .md)
  1. Si vous écrivez un post pour la première fois, il faut aussi créer votre biographie dans /docs/_authors/.

Le nom du fichier est <pseudo>.md, de préférence en utilisant prenom.nom, par exemple estelle.landry.md.

username: angelique
name: Angélique Jard
twitter: ahenryjard
image: /assets/core-team/angie-e1617697051713.jpg
---

Biograhie au format markdown.
  • username: identique au speudo
  • name: Prénom Nom
  • twitter: (facultatif) compte twitter (actuellement pas utilisé)
  • image: (facultatif)
  • n'oubliez pas d'ajouter votre bio.

  1. Rédigez votre contenu au format markdown. Il est conseillé pour faciliter la revue de passer à la ligne en fin de phrase (ça ne change pas le rendu et ça permet d'avoir des suggestions sur un texte plus court).

  2. Si vous avez des images à ajouter, créer un répertoire du même nom que le fichier markdown dans /docs/assets/, vous pouvez ensuite les utiliser avec

![Texte descriptif](/assets/YYYY-MM-dd-titre-du-post/image.jpg)

  1. (Optionel) Tester le rendu en local en lançant les commandes jekyll depuis le répertoire /docs avec jekyll serve, le blog est visible sur http://localhost:4000

  2. Commitez et Proposez la Pull Request sur le site Duchess. Vous pouvez proposez une Pull Request avec un contenu non terminée, dans ce cas il est conseillé de faire une Pull Request de type "draft" (option préférée) ou préfixer le titre de la Pull Request par [DRAFT] sur github.

  3. Une fois la Pull Request revue, une des membres de la Core Team mergera la Pull Request et le post sera publié.

Modifier le site

Pre-requis

  • Installer git
  • Ouvrir le dossier docs cd docs

Lancer le site en local

Via docker-compose

  • Installer docker et docker-compose
  • Lancer le site en utilisant la commande docker-compose up
  • Attendre jusqu'à voir dans la console:
Server address: http://0.0.0.0:4000/

En jekyll natif

  • Installer jekyll en suivant la doc officielle https://jekyllrb.com/docs/pages/
  • Installer les gem avec la commande bundle install dans docs
  • Et lancer le site en utilisant les commandes suivantes :
cd docs
bundle exec jekyll serve --future

Le --future est utile pour voir les posts a une date ultérieure.

Pour proposer un changement

  • Faire un fork du repo (via le bouton "fork" en haut à droite)
  • Cloner le fork sur votre PC
  • créer une branche avec un nom (changez "mabranche"):
git checkout -b mabranche
  • Effectuer les modifications
  • Tester le rendu en local
  • Proposer une Pull Request

Références