To add a new Learning Path, first decide the appropriate category. There are 5 categories into which you can contribute content:
Place your Learning Path in the category closest to the environment where the software runs. The tags on the front page of the website help explain the categories. Feel free to ask on GitHub if you are unsure which category best matches your Learning Path.
You can also add a new install guide. Install guides are short descriptions providing commonly used information to install tools and software. Install guides are easy to reference from multiple Learning Paths and avoid repetition.
This section creates a new Learning Path. Refer to the next section to create a new install guide.
Start creating your Learning Path from the template provided using a straightforward one-line command. For example, to create a new Learning Path with the directory name my-new-learning-path under the microcontrollers category, run the following command from the root directory of this project:
hugo new --kind learning-path learning-paths/microcontrollers/my-new-learning-path
Result: The following markdown files are added to the my-new-learning-path directory:
| Files | Details |
|---|---|
| _index.md | This file contains the title, target audience, and tagging metadata for your new Learning Path. The next step of this Learning Path explains these metadata elements and how to complete them correctly. |
| how-to-1.md | This file contains the how-to content for the Learning Path. Create multiple how-to pages to segment stages within your Learning Path. Each how-to-N.md file represents another distinct stage in your learning Path. Name this file to reflect the content you are adding. |
| example-picture.png | (optional) Pictures and screenshots can be included in this directory to appear in your Learning Path, Images can also be referenced as web links if you prefer. |
| _review.md | This file contains simple questions and answers to reinforce knowledge gained from your Learning Path. |
| _next_steps.md | This file contains the next recommended steps and related resources for the reader to use on completion of this Learning Path. |
Each markdown file has a field called weight. Use this field to order the way your content is displayed. The content with the lowest weight is displayed first.
The _index.md is first with weight: 1. You should start with weight: 2 for your next page (how-to-1.md) and weight: 3 for the page you want displayed after that.
Create a new install guide by copying an existing file in the content/install-guides directory and modifying the contents.
For example, copy the AWS CLI install guide to create your new install guide.
cp content/install-guides/aws-cli.md content/install-guides/my-new-install-guide.md
Use a text editor to open my-new-install-guide.md and change the title of the new install guide to your desired title.
The new install guide will be visible in the install guide category when you run hugo server in the next section. You can continue to edit the file to create your new install guide.
You can verify you have correctly copied the template by viewing the new Learning Path.
If Hugo is not already running start it.
hugo server
View the Learning Path you just created in your browser by opening http://localhost:1313/learning-paths/servers-and-cloud-computing/my-new-learning-path
Refer to the appendix listed below for content formatting and style guidance
You should take a few minutes to understand how to format your Learning Path and review the writing style guide to learn how to best write for the target audience.
You can now start modifying the markdown files using your text editor to write content for your new Learning Path.
Check the results in the browser to see how they look.