From 8d12f427f16680bd890e97bf74a42d45dd924904 Mon Sep 17 00:00:00 2001 From: Jonathan Jalouzot Date: Thu, 8 Jun 2017 13:59:37 +0200 Subject: [PATCH 1/3] feat(doc): add documentation for blog --- .github/CONTRIBUTING.md | 42 +++++++++ .github/ISSUE_TEMPLATE.md | 9 ++ .github/PULL_REQUEST_TEMPLATE.md | 0 README.md | 150 ++++++++++++++++++++++++++++--- _authors/template-autor.md | 7 ++ _drafts/template-article.md | 0 6 files changed, 198 insertions(+), 10 deletions(-) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 _authors/template-autor.md create mode 100644 _drafts/template-article.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..0f6dc3020 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,42 @@ +CREATION D'UNE ISSUE +--------------------------------- +Un template de l'issue est déjà prêt lors de la création de cette dernière. +Il faut alors expliquer le besoin fonctionnel de votre issue ainsi que la façon de valider le développement. + +Si votre issue permet la correction d'un bug, il faut ajouter le label `fix` à votre issue. +Si votre issue permet de mettre en place une nouvelle fonctionnalité , il faut ajouter le label `feat`à votre issue. + +Si vous ne pouvez pas remplir la partie spécification technique, il faut ajouter le label `to be specified`. +Une fois le cadrage technique validé l'issue devra être complété, elle est alors validé et envoyé dans dans le projet suivant https://github.com/orgs/eleven-labs/projects/1. + +------------------------------------------------------------ +DEVELOPPER UNE ISSUE +------------------------------ + +Si vous souhaitez développer une issue, rien de plus simple allez sur l'url suivante https://github.com/orgs/eleven-labs/projects/1 et déplace l'issue dans `Doing`. +Vous pouvez ensuite développer, une fois le développement terminer vous devez faire une pull request. + +** ATTENTION** le naming de votre branche est important. +Pour un `fix` la branche doit se nommer. +```sh +git checkout -b fix/NUMERO-D-ISSUE-TITRE +``` + +Ensuite faite votre pull request avec les labels `fix`et `to be validated` . + +Pour un `feat` la branche doit se nommer. +```sh +git checkout -b feat/NUMERO-D-ISSUE-TITRE +``` + +Ensuite faite votre pull request avec les labels `feat`et `to be validated` . + +Il faut ensuite déplacer votre issue dans le projet https://github.com/orgs/eleven-labs/projects/1 dans la colonne `Review`. + +---------------------------------------- +CODE REVIEW +------------------- +Tout le monde peut faire des codes review, la pull request doit être validé par minimum deux personnes. +Après la seconde code review valide, il faut mettre le label `mergeable`. + +La pull request sera ensuite mergé par un admin et mise en production. diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..0fddd17f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,9 @@ +BESOIN FONCTIONNEL +------------------------------- + - Quel est le besoin ? + + - Comment valider ? + +SPECIFICATION TECHNIQUE +------------------------------------------ +*A définir par les développeurs* diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..e69de29bb diff --git a/README.md b/README.md index 5fe9f79cc..5dc6f933d 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,148 @@ -# Configuration des auteurs de posts +Participer à notre blog +=================== -Chaque auteur a ses informations dans `_authors/{username}.md`.
Si le fichier correspondant à votre nom n'existe pas, il n'y plus qu'à le créer, et voir le resultat sur `/authors/:login` +Bienvenue sur le blog d'[ElevenLabs](http://blog.eleven-labs.com), il s'agit d'un site en Jekyll sur lequel **tout le monde** peut participer. -# Type Theme +---------- -![Default Type Theme blog](https://cloud.githubusercontent.com/assets/816965/5142407/19742e48-71d6-11e4-8d9d-fdfe010784f0.png) +Installer le blog +------------- -A free and open-source [Jekyll](http://jekyllrb.com) theme. Great for blogs and easy to customize. +Le blog s'installe comme un projet classique. -## Get Started +**Prérequis** -[Demo](https://rohanchandra.github.io/type-theme/) +Avoir [ruby](https://www.ruby-lang.org/fr/) d'installer sur sa machine dernière version. -[Using Type](https://rohanchandra.github.io/project/type/) +**1 - Cloner le projet** +```bash +git clone git@github.com:eleven-labs/eleven-labs.github.io.git +``` -## License -The MIT License (MIT) +**2 - Installer Jekyll** +```bash +gem install jekyll bundler +``` +**3 - Lancer le blog** +```bash +cd eleven-labs.github.io && bundle exec jekyll serve +``` +Vous devriez avoir le blog qui s'affiche dans votre navigateur préféré à l'adresse suivante http://localhost:4000 + +-------------------------------------------------------------------- + +Créer votre page auteur +------------------------- +**1 - Ajoutez votre page** + +Dans le dossier `_authors` ajouter votre page. +```bash +cd _authors && touch login.md +``` +**2 - Remplissez votre fiche** + +Veuillez utiliser le template d'auteur suivant, vous pouvez copier template disponible dans le fichier `_authors/template-autor.md` + +```md +--- +layout: author +login: votre_login +name: Prénom Nom +twitter: Compte twitter +--- +Votre Bio +``` + +**3 - Faite votre pull request** + +Vous pouvez créer votre branche, avec le naming suivant. +```bash +git checkout -b feat/add-author-login +``` + +Il ne vous reste plus qu'a faire votre pull request, en mettant le TAG `publication`. + +------------------------- + +Créer votre article +---------------------------- + +**1 - Ajoutez votre article** + +Dans le dossier `_drafts` ajoutez un fichier pour votre article avec le naming suivant. + +```bash +AAAA-MM-DD-titre.md +``` + +**2 - Remplissez le template d'article** + +Veuillez utiliser le template d'article suivant, vous pouvez copier template disponible dans le fichier `_drafts/template-article.md` + +```md +--- +layout: post +title: TITRE +excerpt: DESCRIPTION (VISIBLE SUR LA HOME) +author: LOGIN +permalink: /LANGUE (fr/en)/TITRE SANS ESPACES/ +categories: + - CATEGORIE 1 + - CATEGORIE 2 + - ... +tags: + - TAG 1 + - TAG 2 + - ... +image: + path: URL D'IMAGE DE HOME + height: HAUTEUR DE L'IMAGE + width: LARGEUR DE L'IMAGE +--- + +VOTRE ARTICLE EN MARKDOWN +``` + +**3 - Ecrivez votre article** + +Votre article doit être écrit en [markdown](https://guides.github.com/features/mastering-markdown/) , il existe de nombreuses solution online pour écrire en markdown comme par exemple: + + - https://stackedit.io + - http://dillinger.io + + Si vous avez besoin de mettre des images dans votre article il faut d'abord les ajouter dans le dossier suivant `assets` puis de les insérer dans votre article. + +```md +![DESCRIPTION](/assets/MON IMAGE) +``` + +**4 - Demandez une la publication** + +Une fois votre article terminer il faut déplacer le fichier de l'article du dossier `_drafts`au dossier `_posts` + +```sh +cp _drafts/AAAA-MM-DD-NOUVEL-ARTICLE.md _posts/AAAA-MM-DD-NOUVEL-ARTICLE.md +``` + +Il vous suffit de faire une pull request avec le nom de branche suivante. + +```bash +git checkout -b feat/add-article-TITRE +``` + +N'oubliez le tag `publication`. + +-------------------------------- + +Mettre en ligne un article +----------- + +**1 - Validation d'un article** + +Tout le monde peut commenter une pull request de `publication`, une fois approuvé elle est mergé dans master. + +**ATTENTION**: Seulement quelques personnes ont le droit de merger les pulls requests + +**2 - On partage** + +L'article est ligne !!! Vous n'avez plus qu'a le partager. diff --git a/_authors/template-autor.md b/_authors/template-autor.md new file mode 100644 index 000000000..0f0d9cd85 --- /dev/null +++ b/_authors/template-autor.md @@ -0,0 +1,7 @@ +--- +layout: author +login: votre_login +name: Prénom Nom +twitter: Compte twitter +--- +Votre Bio diff --git a/_drafts/template-article.md b/_drafts/template-article.md new file mode 100644 index 000000000..e69de29bb From b5c9764820f769c5bf66f6f302aac7202b0d20ff Mon Sep 17 00:00:00 2001 From: Jonathan Jalouzot Date: Thu, 8 Jun 2017 13:59:37 +0200 Subject: [PATCH 2/3] feat(doc): add documentation for blog --- README.md | 16 +++++++++------- _authors/TEMPLATE-AUTOR | 7 +++++++ _drafts/TEMPLATE-ARTICLE | 21 +++++++++++++++++++++ 3 files changed, 37 insertions(+), 7 deletions(-) create mode 100644 _authors/TEMPLATE-AUTOR create mode 100644 _drafts/TEMPLATE-ARTICLE diff --git a/README.md b/README.md index 5dc6f933d..e4a069a35 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,11 @@ git clone git@github.com:eleven-labs/eleven-labs.github.io.git **2 - Installer Jekyll** ```bash -gem install jekyll bundler +cd eleven-labs.github.io && bundle install ``` **3 - Lancer le blog** ```bash -cd eleven-labs.github.io && bundle exec jekyll serve +bundle exec jekyll serve ``` Vous devriez avoir le blog qui s'affiche dans votre navigateur préféré à l'adresse suivante http://localhost:4000 @@ -41,7 +41,7 @@ cd _authors && touch login.md ``` **2 - Remplissez votre fiche** -Veuillez utiliser le template d'auteur suivant, vous pouvez copier template disponible dans le fichier `_authors/template-autor.md` +Veuillez utiliser le template d'auteur suivant, vous pouvez copier template disponible dans le fichier `_authors/TEMPLATE-AUTOR` ```md --- @@ -77,7 +77,7 @@ AAAA-MM-DD-titre.md **2 - Remplissez le template d'article** -Veuillez utiliser le template d'article suivant, vous pouvez copier template disponible dans le fichier `_drafts/template-article.md` +Veuillez utiliser le template d'article suivant, vous pouvez copier template disponible dans le fichier `_drafts/TEMPLATE-ARTICLE` ```md --- @@ -103,6 +103,8 @@ image: VOTRE ARTICLE EN MARKDOWN ``` +**ATTENTION** S'il s'agit de la reprise d'un article il faut garder le même lien qu'actuellement sur le site dans le `permalink`. + **3 - Ecrivez votre article** Votre article doit être écrit en [markdown](https://guides.github.com/features/mastering-markdown/) , il existe de nombreuses solution online pour écrire en markdown comme par exemple: @@ -110,10 +112,10 @@ Votre article doit être écrit en [markdown](https://guides.github.com/features - https://stackedit.io - http://dillinger.io - Si vous avez besoin de mettre des images dans votre article il faut d'abord les ajouter dans le dossier suivant `assets` puis de les insérer dans votre article. + Si vous avez besoin de mettre des images dans votre article il faut d'abord les ajouter dans le dossier suivant `assets/AAAA-MM-DD-titre/` puis de les insérer dans votre article. ```md -![DESCRIPTION](/assets/MON IMAGE) +![DESCRIPTION](/assets/AAAA-MM-DD-titre/MON IMAGE) ``` **4 - Demandez une la publication** @@ -145,4 +147,4 @@ Tout le monde peut commenter une pull request de `publication`, une fois approuv **2 - On partage** -L'article est ligne !!! Vous n'avez plus qu'a le partager. +L'article est en ligne !!! Vous n'avez plus qu'a le partager. diff --git a/_authors/TEMPLATE-AUTOR b/_authors/TEMPLATE-AUTOR new file mode 100644 index 000000000..0f0d9cd85 --- /dev/null +++ b/_authors/TEMPLATE-AUTOR @@ -0,0 +1,7 @@ +--- +layout: author +login: votre_login +name: Prénom Nom +twitter: Compte twitter +--- +Votre Bio diff --git a/_drafts/TEMPLATE-ARTICLE b/_drafts/TEMPLATE-ARTICLE new file mode 100644 index 000000000..ef8fa5a5b --- /dev/null +++ b/_drafts/TEMPLATE-ARTICLE @@ -0,0 +1,21 @@ +--- +layout: post +title: TITRE +excerpt: DESCRIPTION (VISIBLE SUR LA HOME) +author: LOGIN +permalink: /LANGUE (fr/en)/TITRE SANS ESPACES/ +categories: + - CATEGORIE 1 + - CATEGORIE 2 + - ... +tags: + - TAG 1 + - TAG 2 + - ... +image: + path: URL D'IMAGE DE HOME + height: HAUTEUR DE L'IMAGE + width: LARGEUR DE L'IMAGE +--- + +VOTRE ARTICLE EN MARKDOWN From da7fa316e8612cfd05617daef3cdfda104252b85 Mon Sep 17 00:00:00 2001 From: Jonathan Jalouzot Date: Tue, 20 Jun 2017 14:55:26 +0200 Subject: [PATCH 3/3] fix: orthographe --- .github/CONTRIBUTING.md | 4 ++-- README.md | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0f6dc3020..90387d40d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -7,7 +7,7 @@ Si votre issue permet la correction d'un bug, il faut ajouter le label `fix` à Si votre issue permet de mettre en place une nouvelle fonctionnalité , il faut ajouter le label `feat`à votre issue. Si vous ne pouvez pas remplir la partie spécification technique, il faut ajouter le label `to be specified`. -Une fois le cadrage technique validé l'issue devra être complété, elle est alors validé et envoyé dans dans le projet suivant https://github.com/orgs/eleven-labs/projects/1. +Une fois le cadrage technique validé l'issue devra être complétée, elle est alors validée et envoyée dans dans le projet suivant https://github.com/orgs/eleven-labs/projects/1. ------------------------------------------------------------ DEVELOPPER UNE ISSUE @@ -22,7 +22,7 @@ Pour un `fix` la branche doit se nommer. git checkout -b fix/NUMERO-D-ISSUE-TITRE ``` -Ensuite faite votre pull request avec les labels `fix`et `to be validated` . +Ensuite faites votre pull request avec les labels `fix`et `to be validated` . Pour un `feat` la branche doit se nommer. ```sh diff --git a/README.md b/README.md index e4a069a35..51b026f47 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ VOTRE ARTICLE EN MARKDOWN **3 - Ecrivez votre article** -Votre article doit être écrit en [markdown](https://guides.github.com/features/mastering-markdown/) , il existe de nombreuses solution online pour écrire en markdown comme par exemple: +Votre article doit être écrit en [markdown](https://guides.github.com/features/mastering-markdown/) , il existe de nombreuses solutions online pour écrire en markdown comme par exemple: - https://stackedit.io - http://dillinger.io @@ -120,19 +120,19 @@ Votre article doit être écrit en [markdown](https://guides.github.com/features **4 - Demandez une la publication** -Une fois votre article terminer il faut déplacer le fichier de l'article du dossier `_drafts`au dossier `_posts` +Une fois votre article terminé il faut déplacer le fichier de l'article du dossier `_drafts`au dossier `_posts` ```sh cp _drafts/AAAA-MM-DD-NOUVEL-ARTICLE.md _posts/AAAA-MM-DD-NOUVEL-ARTICLE.md ``` -Il vous suffit de faire une pull request avec le nom de branche suivante. +Il vous suffit de faire une pull request avec le nom de branche suivant. ```bash git checkout -b feat/add-article-TITRE ``` -N'oubliez le tag `publication`. +N'oubliez pas le tag `publication`. -------------------------------- @@ -141,10 +141,10 @@ Mettre en ligne un article **1 - Validation d'un article** -Tout le monde peut commenter une pull request de `publication`, une fois approuvé elle est mergé dans master. +Tout le monde peut commenter une pull request de `publication`, une fois approuvée elle est mergée dans master. **ATTENTION**: Seulement quelques personnes ont le droit de merger les pulls requests **2 - On partage** -L'article est en ligne !!! Vous n'avez plus qu'a le partager. +L'article est en ligne !!! Vous n'avez plus qu'à le partager.