Ajouter un livre sur Plan ₿ Academy

• Tout d'abord, il vous faut avoir un compte sur GitHub. Si vous ne savez pas comment créer un compte, nous avons fait un tutoriel détaillé pour vous accompagner.

Compte GitHubComment créer son propre compte sur GitHub ?

• Rendez-vous sur le dépôt GitHub de Plan₿ dédié à la data dans la section resources/books/ :

• Cliquez en haut à droite sur le bouton Add file, puis sur Create new file :

• Si vous n'avez encore jamais contribué sur les contenus de Plan ₿ Academy, vous allez devoir créer votre fork du dépôt original. Faire un fork d'un dépôt consiste à créer une copie de ce dépôt sur votre propre compte GitHub, ce qui vous permet de travailler sur le projet sans affecter le dépôt original. Cliquez sur le bouton Fork this repository :

• Vous arrivez ensuite sur la page d'édition de GitHub :

• Créez un dossier pour votre livre. Pour ce faire, dans la case Name your file..., notez le nom de votre livre en minuscules avec des tirets à la place des espaces. Par exemple, si votre ouvrage s'appelle "My Bitcoin Book", vous devez noter my-bitcoin-book :

• Pour valider la création du dossier, il suffit d'ajouter un slash à la suite de votre nom de livre dans la même case, par exemple : my-bitcoin-book/. Le fait d'ajouter un slash permet de créer automatiquement un dossier plutôt qu'un fichier :

• Dans ce dossier, vous allez créer un premier fichier YAML nommé book.yml :

• Remplissez ce fichier avec les informations relatives à votre livre à l'aide de ce template :

author: 
level: 
tags:
  - 
  - 

• author : Indiquez le nom de l'auteur du livre.
• level : Indiquez le niveau requis pour pouvoir lire et bien comprendre le livre. Choisissez un niveau parmi les suivants :
  • beginner
  • intermediate
  • advanced
  • expert
• tags : Ajoutez deux ou trois étiquettes associées à votre livre. Par exemple :
  • bitcoin
  • history
  • technology
  • economy
  • education...

author: Loïc Morel
level: beginner
tags:
  - bitcoin
  - technology

• Une fois vos modifications sur ce fichier terminées, enregistrez-les en cliquant sur le bouton Commit changes... :

• Ajoutez un titre pour vos modifications, ainsi qu'une courte description :

• Cliquez sur le bouton vert Propose changes :

• Vous arrivez ensuite sur une page qui résume tous vos changements :

• Cliquez sur votre image de profil GitHub en haut à droite, puis sur Your Repositories :

• Sélectionnez votre fork du dépôt de Plan ₿ Academy :

• Vous devriez voir apparaître sur le haut de la fenêtre une notification avec votre nouvelle branche. Elle s'appelle sûrement patch-1. Cliquez dessus :

• Vous êtes maintenant sur votre branche de travail :

• Retournez dans le dossier resources/books/ et sélectionnez le dossier de votre livre que vous venez de créer dans le commit précédent :

• Dans le dossier de votre livre, cliquez sur le bouton Add file, puis sur Create new file :

• Nommez ce nouveau dossier assets et confirmez sa création en mettant un slash / à la fin :

• Dans ce dossier assets, créez un fichier nommé .gitkeep :

• Cliquez sur le bouton Commit changes... :

• Laissez le titre du commit par défaut, et vérifiez bien que la case Commit directly to the patch-1 branch est cochée, puis cliquez sur Commit changes :

• Retournez dans le dossier assets :

• Cliquez sur le bouton Add file, puis sur Upload files :

• Une nouvelle page va s'ouvrir. Glissez et déposez dans la zone l'image de couverture de votre livre. Cette image sera affichée sur le site de Plan ₿ Academy :

• Attention, l'image doit être dans le format d'un livre, afin de s'adapter au mieux à notre site web, comme par exemple :

• Une fois l'image chargée, vérifiez que la case Commit directly to the patch-1 branch est cochée, puis cliquez sur Commit changes :

• Attention, votre image doit être nommée cover_en si la couverture est en anglais et doit être au format .webp. Ainsi, le nom complet du fichier devrait être cover_en.webp, cover_fr.webp, cover_it.webp, etc. Si vous désirez utiliser une image de couverture différente pour chaque langue, par exemple en cas de traduction de l'ouvrage, vous pouvez les placer au même endroit dans le dossier assets :

• Retournez dans votre dossier assets et cliquez sur le fichier intermédiaire .gitkeep :

• Une fois sur le fichier, cliquez sur les 3 petits points en haut à droite puis sur Delete file :

• Vérifiez que vous êtes toujours sur la même branche de travail, puis cliquez sur le bouton Commit changes... :

• Ajoutez un titre et une description à votre commit, puis cliquez sur Commit changes :

• Retournez dans le dossier de votre livre :

• Cliquez sur le bouton Add file, puis sur Create new file :

• Créez un nouveau fichier YAML en le nommant avec l'indicateur de la langue du livre. Ce fichier va être utilisé pour la description de l'ouvrage. Par exemple, si je veux rédiger ma description en anglais, je vais nommer ce fichier en.yml :

• Remplissez ce fichier YAML à l'aide de ce modèle :

title: ""
publication_year: 
cover: cover_en.webp
original: true
description: |

contributors:
  - 

• title : Indiquez le nom du livre entre guillemets.
• publication_year : Indiquez l'année de publication du livre.
• cover : Indiquez le nom du fichier correspondant à l'image de couverture, en accord avec la langue du fichier YAML que vous éditez actuellement. Par exemple, si vous modifiez le fichier en.yml et que vous avez préalablement ajouté l'image de couverture anglaise intitulée cover_en.webp, indiquez simplement cover_en.webp dans ce champ.
• description : Ajoutez un court paragraphe qui décrit le livre. La description doit être dans la même langue que celle indiquée dans le titre du fichier YAML.
• contributors : Ajoutez votre identifiant de contributeur si vous en avez un.

title: "My Bitcoin Book"
publication_year: 2021
cover: cover_en.webp
original: true
description: |
 Discover the groundbreaking world of Bitcoin with this comprehensive guide tailored for beginners. My Bitcoin Book demystifies the complexities of Bitcoin, providing a clear and concise introduction to how the protocol works. From its revolutionary technology to its potential impact on the global economy, this book offers invaluable insights and practical knowledge. Perfect for those new to Bitcoin, it covers the basics, security tips, and the future of digital finance. Dive into the future of money and empower yourself with the knowledge to navigate the digital age confidently.
contributors:
  - pretty-private

• Cliquez sur le bouton Commit changes... :

• Vérifiez que la case Commit directly to the patch-1 branch est cochée, ajoutez un titre, puis cliquez sur Commit changes :

• Le dossier du livre devrait dorénavant ressembler à celui-ci :

• Si tout vous convient, revenez à la racine de votre fork :

• Vous devriez voir apparaître un message vous indiquant que votre branche a subi des modifications. Cliquez sur le bouton Compare & pull request :

• Ajoutez un titre clair et une description sur votre PR :

• Cliquez sur le bouton Create pull request :