Adding Educational Tools

It is imperative that all content integrated into the site is free of rights or respects the source file's license. Also, all visuals published on Plan ₿ Academy are made available under the CC-BY-SA license.

• First, you need to have an account on GitHub. If you don't know how to create an account, we have made a detailed tutorial to guide you.

GitHub AccountHow to create your own account on GitHub?

• Go to the GitHub repository of PlanB dedicated to data in the resources/bet/ section:
• Click on the top right on the Add file button, then on Create new file:
• If you have never contributed to the contents of Plan ₿ Academy before, you will need to create your fork of the original repository. Forking a repository means creating a copy of that repository on your own GitHub account, which allows you to work on the project without affecting the original repository. Click on the Fork this repository button:
• You will then arrive at the GitHub editing page:
• Create a folder for your content. To do this, in the Name your file... box, write the name of your content in lowercase with dashes instead of spaces. In my example, let's say I want to add a PDF visual of the 2048-word BIP39 list. So, I will call my folder bip39-wordlist:
• To confirm the creation of the folder, simply add a slash after the name in the same box, for example: bip39-wordlist/. Adding a slash automatically creates a folder rather than a file:
• In this folder, you will create a first YAML file named bet.yml:
• Fill this file with information related to your content using this template:

project: 
type: 
links:
  download: 
  view: 
    - en: 
tags:
  - 
  - 
contributors:
  - 

• project: Indicate your organization's identifier on Plan ₿ Academy. If you do not yet have a "project" identifier for your company, you can create one by following this tutorial.

Adding a ProjectHow to propose the addition of a new project on Plan ₿ Academy?

• type: Select the nature of your content among the following two options:
  • Educational Content for educational contents.
  • Visual Content for other types of diverse contents.
• links: Provide links to your contents. You have two options:
  • If you choose to host your content directly on PlanB's GitHub, you will need to add the links to this file during the following steps.
  • If your contents are hosted elsewhere, like on your personal website, indicate the corresponding links here:
    • download: A link to download your content.
    • view: A link to view your content (can be the same as the download link). If your content is available in multiple languages, add a link for each language.
• tags: Add two tags associated with your content. Examples:
  • bitcoin
  • technology
  • economy
  • education
  • meme...
• contributors: Mention your contributor identifier if you have one.

project: Plan ₿ Academy
type: Educational Content
links:
  download: https://workspace.planb.network/s/fojeJa7ZbftQTwo
  view:

• In my example, I will leave the links empty for now, as I will add my PDF directly on GitHub:
• Once your modifications to this file are complete, save them by clicking on the Commit changes... button:
• Add a title for your modifications, as well as a short description:
• Click on the green Propose changes button:
• You will then arrive on a page that summarizes all your changes:
• Click on your GitHub profile picture at the top right, then on Your Repositories:
• Select your fork of the Plan ₿ Academy repository:
• You should see a notification at the top of the window with your new branch. It is probably called patch-1. Click on it:
• You are now on your working branch (make sure you are on the same branch as your previous modifications, this is important!):
• Go back to the resources/bet/ folder and select the folder of your content that you just created in the previous commit:
• In the folder of your content, click on the Add file button, then on Create new file:
• Name this new folder assets and confirm its creation by putting a slash / at the end:
• In this assets folder, create a file named .gitkeep:
• Click on the Commit changes... button:
• Leave the commit title as default, and make sure the Commit directly to the patch-1 branch box is checked, then click on Commit changes:
• Return to the assets folder:
• Click on the Add file button, then on Upload files:
• A new page will open. Drag and drop a thumbnail that represents your content into the area. This image will be displayed on the Plan ₿ Academy site:
• It can be a preview, a logo, or an icon:
• Once the image is uploaded, make sure the Commit directly to the patch-1 branch box is checked, then click on Commit changes:
• Be careful, your image must be named logo and must be in .webp format. The full file name should therefore be: logo.webp:
• Return to your assets folder and click on the intermediary file .gitkeep:
• Once on the file, click on the three small dots at the top right then on Delete file:
• Make sure you are still on the same working branch, then click on the Commit changes button:
• Add a title and a description to your commit, then click on Commit changes:
• Return to the folder of your content:
• Click on the Add file button, then on Create new file:
• Create a new YAML file by naming it with the indicator of your native language. This file will be used for the content description. For example, if I want to write my description in English, I will name this file en.yml:
• Fill out this YAML file using this template:

name: 
description: |
  

• For the name key, you can add the name of your content;
• For the description key, you simply need to add a short paragraph that describes your content. The description must be in the same language as the file name. You do not need to translate this description into all the supported languages on the site, as the PlanB teams will do so with their model. For example, here is what your file might look like:

name: BIP39 WORDLIST
description: |
  Complete and numbered list of the 2048 English words from the BIP39 dictionary used to encode mnemonic phrases. The document can be printed on a single page.

• Click on the Commit changes... button:
• Ensure that the Commit directly to the patch-1 branch box is checked, add a title, then click on Commit changes:
• Your content folder should now look like this:

• Return to the /assets folder:
• Click on the Add file button, then on Upload files:
• A new page will open. Drag and drop into the area the content you wish to share:
• For example, I added the PDF file of the BIP39 list:
• Once the content is uploaded, ensure that the Commit directly to the patch-1 branch box is checked, then click on Commit changes:
• Return to your /assets folder and click on the file you just uploaded:
• Retrieve the intermediate URL of your file. For example, in my case, the URL is:

https://github.com/tutorial-pandul/bitcoin-educational-content/blob/patch-1/resources/bet/bip39-wordlist/assets/BIP39-WORDLIST.pdf

• Keep only the last part of the URL from /resources onwards:

/resources/bet/bip39-wordlist/assets/BIP39-WORDLIST.pdf

• Add to the base of the URL the following information to have the correct link:

https://github.com/DiscoverBitcoin/bitcoin-educational-content/blob/dev/resources/bet/bip39-wordlist/assets/BIP39-WORDLIST.pdf

• Go back to your bet.yml file and click on the pencil icon:
• Add your link there:
• Once your changes are complete, click on the Commit changes... button:
• Add a title for your changes, as well as a short description:
• Click on the green Commit changes button:

• If everything looks good to you, return to the root of your fork:
• You should see a message indicating that your branch has been modified. Click on the Compare & pull request button:
• Add a clear title and a description for your PR:
• Click on the Create pull request button: Congratulations! Your PR has been successfully created. An administrator will now review it and, if everything is in order, merge it into the main repository of Plan ₿ Academy. You should see your BET appear on the website a few days later.

Be sure to follow the progress of your PR. An administrator may leave a comment asking for additional information. As long as your PR is not validated, you can consult it in the Pull requests tab on the Plan ₿ Academy GitHub repository: Thank you very much for your valuable contribution! :)