Last but not least, the final deliverable that will be displayed in the Project Gallery. We don't want you to write new stuff, you have done more than enough

PS: You don't have to install Hugo to add your document and make the pull request. The file you will have to edit has all the instruction embedded for the two different sections you need to fill in. (e.i, the frontmatter or header of the document, and the content section).

This document will guide you through the whole Git/Github workflow that you are probably becoming expert at ;).

• Fork the BrainHack school website repository @ https://github.com/BrainhackMTL/school
• Clone your newly forked repo on your computer.
• Go in school/content/en/project/. Then, copy and paste the template/ directory in school/content/en/project/.
• Change the name of the template copy/ directory to a significant one. The name you give to the folder will become the page that your project will be accessible. For example, thefake project is accessible at https://school.brainhackmtl.org/project/fake. So, make sure to pick a nice and relevant short name ;). PS: if you want more than one word, replace the space between words by -.
• Now you can delete all the pictures and put the ones you want to use for you project.
• Last but not least, you need to edit the content inside the your-project/index.md file. Use the editor you want (e.g., nano, vim, VSC, Atom, etc.) to modify it.
  • The frontmatter section (header) contains specific parameters and it is really important to follow the format described in the instructions above each line. The frontmatter section is delimited by a --- at the top and another one at the end of it.
  • When you edit the content section (below the second ---), you can edit the markdown as you wish. Feel free to embed video, GIF, images, plots, etc.
• When you are pleased with your report, you can staged your changes after having saved them, commit them, then push them.
• You will have to go back on forked github repo to make the pull request. You should see a gree button on the right Make a pull request.
• If you everything was done properly, an instructor will merge your pull request and inform you that you are finally done. If some changes need to be made, the instructor will ask you what should be change on you branch. If that happens, you can commit more changes and it will be automatically linked. Simply tag the instructor who reviewed your pull request and you should be finally done
  Image Not Showing Possible Reasons

  • The image file may be corrupted
  • The server hosting the image is unavailable
  • The image path is incorrect
  • The image format is not supported

  Learn More →
  .

Congrats!!