Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
feat(doc): add documentation for blog
  • Loading branch information
CaptainJojo authored and eko committed Jun 23, 2017
1 parent b1a94e3 commit 4861679
Show file tree
Hide file tree
Showing 6 changed files with 198 additions and 10 deletions.
42 changes: 42 additions & 0 deletions .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.
9 changes: 9 additions & 0 deletions .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*
Empty file.
150 changes: 140 additions & 10 deletions README.md
@@ -1,18 +1,148 @@
# Configuration des auteurs de posts
Participer à notre blog
===================

Chaque auteur a ses informations dans `_authors/{username}.md`. <br />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.
7 changes: 7 additions & 0 deletions _authors/template-autor.md
@@ -0,0 +1,7 @@
---
layout: author
login: votre_login
name: Prénom Nom
twitter: Compte twitter
---
Votre Bio
Empty file added _drafts/template-article.md
Empty file.

0 comments on commit 4861679

Please sign in to comment.