Adding a Conference Replay

Loïc MorelLoïc Morel
Aug 4, 2024
Aug 4, 2024
PlanB's mission is to provide top-tier educational resources on Bitcoin in as many languages as possible. All content published on the site is open-source and hosted on GitHub, allowing anyone to contribute to the platform's enrichment.
Do you want to add the replay of your Bitcoin conference on the Plan ₿ Academy site and give visibility to this event, but don't know how? This tutorial is for you!
However, if you want to add a conference that will take place in the future, I advise you to read this other tutorial in which we explain how to add a new event to the site.
  • 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.
  • Go to the GitHub repository of PlanB dedicated to data in the resources/conference/ 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 conference. To do this, in the Name your file... box, write the name of your conference in lowercase with dashes instead of spaces. For example, if your conference is called "Paris Bitcoin Conference", you should note paris-bitcoin-conference. Also add the year of your conference, for example: paris-bitcoin-conference-2024:
  • To validate the creation of the folder, simply note a slash after your name in the same box, for example: paris-bitcoin-conference-2024/. Adding a slash automatically creates a folder rather than a file:
  • In this folder, you will create a first YAML file named conference.yml: Fill this file with information related to your conference using this template:
year: name: project: location: language: - links: website: twitter: tags: - -
For example, your YAML file could look like this:
year: 2024-08 name: Paris Bitcoin Conference 2024 project: Paris Bitcoin Conference location: Paris, France language: - fr - en links: website: https://paris.bitcoin.fr/conference twitter: https://twitter.com/ParisBitcoinConference tags: - International - All Public
If you do not yet have a "project" identifier for your organization, you can add it by following this other tutorial.
  • Once you have finished making changes to this file, save them by clicking on the Commit changes... button:
  • Add a title for your changes, as well as a short description:
  • Click on the green Propose changes button:
  • You will then arrive at a page summarizing 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:
  • Return to the resources/conference/ folder and select the folder of your conference that you just created in the previous commit:
  • In the folder of your conference, 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 an image that represents your conference and will be displayed on the Plan ₿ Academy site:
  • It can be a logo, a thumbnail, or even a poster:
  • Once the image is uploaded, check that the Commit directly to the patch-1 branch box is checked, then click on Commit changes:
  • Be careful, your image must be named thumbnail and must be in .webp format. The full file name should therefore be: thumbnail.webp:
  • Return to your assets folder and click on the .gitkeep intermediary file:
  • Once on the file, click on the 3 small dots in the top right corner then on Delete file:
  • Verify that 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:
  • Go back to your conference folder:
  • Click on the Add file button, then on Create new file:
  • Create a new markdown (.md) file by naming it with the indicator of your native language. This file will be used for the replays of your conference. For example, if I want to write the descriptions of the conferences in English, I will name this file en.md:
  • Fill out this markdown file using this template that you can adapt to the configuration of your conference:
--- name: Paris Bitcoin Conference 2024 description: The largest Bitcoin conference in France with over 8,000 participants each year! --- # Main Stage ## Friday morning ![video](https://youtu.be/XXXXXXXXXXXX) ## Friday afternoon ![video](https://youtu.be/XXXXXXXXXXXX) ## Saturday morning ![video](https://youtu.be/XXXXXXXXXXXX) ## Saturday afternoon ![video](https://youtu.be/XXXXXXXXXXXX) # Workshop Room ## The Future of Bitcoin Mining: Challenges and Innovations ![video](https://youtu.be/XXXXXXXXXXXX) Speaker: Satoshi Nakamoto, Satoshi Nakamoto ## Is Privacy Still Possible On Bitcoin? ![video](https://youtu.be/XXXXXXXXXXXX) Speaker: Satoshi Nakamoto ## Bitcoin Core: Deep Dive into the Codebase ![video](https://youtu.be/XXXXXXXXXXXX) Speaker: Satoshi Nakamoto, Satoshi Nakamoto, Satoshi Nakamoto, Satoshi Nakamoto ## Building and Securing Bitcoin Wallets With Miniscript ![video](https://youtu.be/XXXXXXXXXXXX) Speaker: Satoshi Nakamoto
  • At the beginning of your document, in the "front matter," fill in the name: field with the name of your conference and the year of the replays. In the description: field, write a short description of your event in the language of the file. For example, for a file named en.md, the description should be in English. The Plan ₿ Academy team will take care of translating your description using their model.
  • First-level titles, marked by a #, are used to organize the conference by scenes. For example, # Main Stage for the main stage and # Workshop Room for a stage dedicated to workshops.
  • Second-level titles, marked by a double ##, are used to separate the different replay videos. If the conferences were filmed continuously over a half-day, indicate, for example, ## Friday morning. If the conferences were filmed and broadcast individually, name the conference directly with a second-level title.
  • Under each second-level title, insert a link to the corresponding replay video. The syntax should be: ![video](https://youtu.be/XXXXXXXXXXXX), replacing XXXXXXXXXXXX with the actual video link.
  • If the format allows (individual conferences), you can add the names of the speakers. To do this, add the Speaker: field followed by the name or pseudonym of the speaker under the video link. In case of multiple speakers, separate each name with a comma, like this for example: Speaker: Satoshi Nakamoto, Satoshi Nakamoto, Satoshi Nakamoto, Satoshi Nakamoto.

  • 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 Commit changes:
  • Your conference folder should now look like this:
  • If everything is to your satisfaction, return to the root of your fork:
  • You should see a message indicating that your branch has undergone modifications. Click on the Compare & pull request button:
  • Add a clear title and 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 the replays of your conference appear on the website a few days later.
Please make sure to follow the progress of your PR. It's possible that an administrator may leave a comment asking for additional information. As long as your PR is not validated, you can view it under the Pull requests tab on the Plan ₿ Academy's GitHub repository:
Thank you very much for your valuable contribution! :)
Did this work well for you?
1
0

Author

This tutorial has been written by Loïc Morel

You can say thanks by tipping the professor.

Credits

This tutorial has not been proofread yet

0/3Proofreading status

The original content has been translated by AI, but human review is necessary to ensure its accuracy.

Progress: 0/32 655 sats1 328 sats664 sats
*Rewards may vary based on the $ exchange rate

Every content on the platform is the result of a collaborative effort: each lesson, translation, and revision is made possible by the work of contributors. For this reason, we are always looking for proofreaders who can review our content in many languages. If you want to participate in the proofreading process, please reach out in our Telegram group and read our tutorial. We remind you that this content is open-source - licensed under CC BY-SA - so it can be freely shared and used, as long as the original source is credited.