Bienvenue dans le journal de bord de Neosys, si vous voulez contribuer au blog, veuillez suivre le guide de démarrage.
Le blog utilise le service d'hébergement des pages statiques GitHub Pages. Ce dernier est compatible avec Jekyll. Jekyll est un générateur de pages statiques orienté blog. Il est développé avec Ruby.
Pour configurer votre environnement de dév local:
- Installez Ruby et son SDK en suivant les instructions sur le lien.
- Clonez le repository.
- Exécutez les instructions suivantes en ligne de commande:
gem install jemoji
gem install jekyll-gist
gem install github-pages
gem install tzinfo-data
gem install wdm
- Placez-vous à la racine du projet et jouer l'instruction
bundler update
en ligne de commande. - Démarrez le blog en local avec la ligne de commande
bundler exec jekyll serve -- force_polling
- Ouvrez le navigateur et allez sur le lien http://localhost:4000/blog/ (surtout n'oubliez pas le dernier /)
Si c'est votre 1er billet, il faudra d'abord créer un nouveau blogueur:
- Ajoutez un fichier markdown (extension .md) dans le dossier
_authors
. - Remplissez toutes vos informations, inspirez-vous de ce qui est déjà existant.
- Si tout est OK, vous allez voir que vous êtes ajouté à la liste des blogueurs sur le lien http://localhost:4000/blog/staff
Pour rédiger le billet:
- créez un nouveau fichier markdown dans le dossier
_posts
. - Taper votre billet en langage markdown (pas de HTML SVP dans le code), inspirez-vous des exemples déjà réalisés.
- Si tout est OK, votre billet s'ajoutera au menu gauche des derniers billets et dans votre espace blogueurs http://localhost:4000/blog/authors/{username}.
- Pour accéder à l'organisation neosys-opentech et pouvoir y contribuer, merci de m'adresser une demande et créer un compte Github si vous ne possédez pas déjà un, et puis je lierai le votre.
- Les code snippets doivent être créés sur Github Gist en visibilité public.
- Lors de la validation de la PR de votre billet: le validateur s'en chargera de forker vos Gists sur le compte Github @ns-blog-gister et vous soumettre les identifiants pour pouvoir les intégrer dans votre billet avant de la valider.
- Gardez à l'esprit que le blog doit rester mobile friendly.
- Les images des billets doivent être annotées avec
{:.ns-post-img-fluid}
pour qu'elles soient responsives. - Les images des billets doivent être rangées dans le dossier
assets/images/posts/{nomDeVotrePost}
. - Poussez vos nouveaux articles dans des branches séparées et créez une CR (qui doit être validée) avant de merger votre article dans la branche master.
- Avant de créer une PR, merci de jouer une build de votre branche avec
bundler exec jekyll build
pour vérifier que votre code compilera sur GitHub.