Each Learning Path contains metadata which is used to create the Learning Path pages. The metadata is used by the website so all Learning Paths have the same information and are consistent.
This section explains how to add Learning Path metadata in the _index.md file:
The following metadata is defined in the _index.md file:
| Learning Path Metadata | Explanation |
|---|---|
| title | Should start with a verb (learn, build), have no adjectives (amazing, cool), and be as concise as possible (limit one sentence). |
| minutes_to_complete | Time to perform the steps in the Learning Path (not just read it). |
| who_is_this_for | One sentence indicating the target audience (developers using tools or software to accomplish tasks). |
| learning_objectives | 2-5 bullet points, one sentence each, describing what a reader will learn. Should start with a verb (deploy, measure). |
| prerequisites | Everything needed before this Learning Path can be started. Can include online service accounts, prior knowledge, previous Learning Paths, or specific tools and software. Offers explanatory links when possible. |
| author | The name of the person or people who wrote the Learning Path. |
Look at other Learning Paths for inspiration about how to write a good title, learning objectives, and prerequisites.
To specify a prerequisite Learning Path, do so with an absolute path from the root of the website. For example:
Note the absolute path of /learning-paths/cross-platform/docker/
Adding yourself as an author by populating the author metadata is slightly different if there is one or multiple authors.
One author:
author: Zach Lasiuk
Multiple authors:
author:
- Zach Lasiuk
- Pareena Verma
In either case, ensure all named authors are listed in the .\assets\contributors.csv file. You must list your name, and optionally include info to display along your name in the Learning Path. This includes your company name, LinkedIn profile, Twitter handle, and your/your company’s website.
Tagging metadata is also expected to increase visibility through filtering. Some tags are closed (you must select from a pre-defined list) and some are open (enter anything). The tags are:
Indicates the skill level needed as a developer to complete this Learning Path.
| Option | Explanation |
|---|---|
| Introductory | Requires minimal experience in this field or previous knowledge about the tools/software involved |
| Advanced | Requires experience with specific topics, tools, or software to properly understand this tutorial |
Specifies the primary subject the Learning Path covers. Can only be one subject per Learning Path; if it spans multiple, pick the primary one. Select from the allowed list for each category, as defined here:
| Embedded and Microcontrollers | IoT | Servers and Cloud Computing | Laptops and Desktops | Mobile, Graphics, and Gaming | Automotive |
|---|---|---|---|---|---|
| CI-CD | CI-CD | CI-CD | CI-CD | CI-CD | CI-CD |
| Performance and Architecture | Performance and Architecture | Performance and Architecture | Performance and Architecture | Performance and Architecture | Performance and Architecture |
| ML | ML | ML | ML | ML | ML |
| Containers and Virtualization | Containers and Virtualization | Containers and Virtualization | Containers and Virtualization | Gaming | Containers and Virtualization |
| Libraries | Libraries | Libraries | Migration to Arm | Libraries | |
| Virtual Hardware | Virtual Hardware | Storage | Graphics | ||
| Security | Security | Databases | AR-VR | ||
| Embedded Linux | Embedded Linux | Web | |||
| RTOS Fundamentals |
Specifies the operating systems this Learning Path can run on. Select from this list:
| OS Options |
|---|
| Linux |
| Windows |
| macOS |
| ChromeOS |
| iOS |
| Android |
| RTOS |
| Baremetal |
Specifies the tools, softwares, or languages this Learning Path uses. Please list out any key tools, software, or languages your Learning Path uses.
| Tag Type | Examples |
|---|---|
| Environments | AWS EC2, GCP |
| Toolchains | GCC, Arm Compiler for Embedded |
| IDEs | Arm Development Studio, VS Code |
| Online Tools | GitHub, Jenkins |
| Assorted | cbuild, Docker |
| Stack | tinyML, CMSIS |
| Language | Python, Java, Assembly |
| Libraries | zlib, snappy |
Specifies the Arm IP this Learning Path involves, providing a quick link to IP information for developers interested in learning more. You can enter multiple specific or groups of IP. Note that this is not used for filtering content, but is clickable for readers to find more information about these IPs through searching automatically on developer.arm.com.
| Grouping Type | When to use | Examples |
|---|---|---|
| Specific IP | The Learning Path covers a specific board with one (or a few) Arm IP | Cortex-M4, Neoverse-N1, Mali-G57 |
| Group of IP | The Learning Path applies to a wider class of Arm IP | Cortex-M, Cortex-A, Cortex-R, Neoverse, Mali |
This is where you provide further reading resources to dive deeper into the topics covered.
| Further Reading metadata | Explanation |
|---|---|
| further_reading | Links to references related to information covered |
| resource > title | The displayed title of the provided further_reading resource |
| resource > link | The website link to the specific resource |
| resource > type | Helps the reader understand what type of resource is being suggested. Can be either: (1) Manuals for a tool / software (type: documentation). (2) Blog about related topics (type: blog). (3) General online references (type: website). |