LEAF-VRE Docusaurus Tutorial

Resources

• URL: https://www.leaf-vre.org/
• GitLab: https://gitlab.com/calincs/cwrc/leaf/leaf-vre-website
• LINCS documentation maintenance instructions: https://portal.lincsproject.ca/docs/about/resources/lincsaurus/maintenance

Before we meet

For more detailed instructions, see the LINCS Maintenance Guide.

1. Confirm you can log into GitLab; you already have an account
   • Diane = @djakacki1
   • Carolyn = @carolynsblack
   • Susan = @SusanIreneBrown
   • James = @jamescummings
2. Download Git​
   • https://git-scm.com/downloads
3. Download VS Code​
   • https://code.visualstudio.com/
4. Download Node.js​
   • https://nodejs.org/en/download/
5. Create and Link an SSH Key to GitLab​
   • Find detailed instructions for how to create and link an SSH key in GitLab’s help documentation. The sections you will need to follow are See if you have an existing SSH key pair, Generate an SSH key pair, and Add an SSH key to your GitLab account.

Before you start writing documentation

1. Learn Markdown​
   • https://www.markdowntutorial.com/
2. Add markdownlint Plugin to VS Code​ [Optional]
3. Add Docs to Markdown Plugin to Google Docs [Optional]​
4. Use Docs to Markdown Plugin in Google Docs [Optional]​

Tutorial topics

1. Clone the repository
2. Create an issue
3. Create a merge request
4. Create a markdown file
5. Organize the files