You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/cloud/academy/creating-your-learning-path/index.md
+55-49Lines changed: 55 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ This guide provides a step-by-step walkthrough for creating and organizing a new
14
14
Before you dive into creating your first learning path, it's helpful to be familiar with the core technologies and concepts used by the Academy platform.
15
15
16
16
-**Git and GitHub**: All learning content is managed in a Git repository.
17
-
-**Markdown**: All course and chapter content is written in standard Markdown.
17
+
-**Markdown**: All content is written in standard Markdown.
18
18
-**Hugo**: The entire Academy platform is built on the [Hugo](https://gohugo.io/) static site generator.
19
19
-**Academy Template & Theme**: We provide an `academy-example` repository that serves as a pre-configured template. [Layer5 Academy theme](https://github.com/layer5io/academy-theme) to ensure your content is styled correctly right out of the box.
20
20
-**A Layer5 Cloud Account**: Required to obtain your Organization ID and Personal Access Token for publishing.
@@ -65,7 +65,7 @@ The Academy uses a specific directory layout to keep each organization's content
65
65
Each learning path is tied to a specific organization and secured by a unique identifier (UUID). This is a system-generated ID that ensures your content is scoped only to your organization.
66
66
67
67
{{< alert type="info" title="How to Find Your Organization UUID?" >}}
68
-
You can find and copy your Organization UUID from your organization page on [Layer5 Cloud](https://cloud.layer5.io/identity/organizations).
68
+
You can find and copy your Organization UUID from your organization page on [Academy](https://cloud.layer5.io/academy).
69
69
{{< /alert >}}
70
70
71
71
2. **Create the Core Directories**
@@ -79,80 +79,89 @@ You can find and copy your Organization UUID from your organization page on [Lay
79
79
80
80
3. **Build the Content Hierarchy**
81
81
82
-
With the main folders in place, you can now structure your first course inside the `content` directory. The content is organized in a clear hierarchy: **Learning Path → Course → Chapter**.
82
+
With the main folders in place, you can now structure your first course inside the `content` directory. The content is organized in a clear hierarchy: **Learning Path → Course → Module → Page, Quiz, or Lab.**
83
83
84
84
A high-level view of the structure looks like this:
Each folder represents a level in the hierarchy, and the `_index.md` file within a folder defines the metadata (like title and description) for that level. The final `.md` files are your individual Chapter.
102
+
Each folder represents a level in the hierarchy. The `_index.md` file within a folder is crucial as it defines the metadata for that level, such as its `title`, `description`, and `type` (e.g., `type: "course"`). The final `.md` files at the lowest level are your individual **Pages**, **Quizzes**, or **Labs**.
102
103
103
104
> For a deeper understanding of how Hugo uses `_index.md` to create content sections, you can refer to the official [Hugo Page Bundles documentation](https://gohugo.io/content-management/page-bundles/).
104
105
105
106
4. **Front matter**
106
107
107
-
Use this at the top of each **Learning Path** page (`learning-paths/<orgId>/<slug>/_index.md` or similar):
108
+
Front matter is the configuration block at the top of every content file that defines its metadata. The most critical field is type, which tells the Academy how to render the content.
109
+
110
+
The front matter configuration varies slightly depending on whether you are creating a Learning Path/Challengs, Course, Module, or Page. The following examples for a Learning Path and a Course illustrate a typical setup.
111
+
112
+
**Learing Path Frontmatter**
108
113
109
114
```yaml
110
115
---
111
-
title: "Advanced Course"
112
-
description: "This ADVANCED - Course is where to get the technical knowledge."
116
+
type: "learning-paths"
117
+
title: "Cloud Fundamentals"
118
+
description: "A learning path focused on providing the technical knowledge required for advanced topics."
113
119
weight: 5
114
-
banner: "images/exoscale-icon.svg"
115
-
id: "754627a3-7993-4b01-a7f0-c66c0212a1a1"
116
-
tags: [orchestration]
117
-
categories: [introductory]
120
+
banner: "images/kubernetes-icon.svg"
121
+
id: "754627a3-2323-4545-a7f0-c66c0212a1a1"
122
+
tags: [kubernetes, infrastructure]
123
+
categories: "cloud"
118
124
---
119
125
```
120
126
121
-
> Place this frontmatter in the Markdown file that represents the learning path index page.
| All | `description` | ✅ | A brief summary of the content. |
150
+
| All | `weight` | ✅ | Controls the display order (lower numbers appear first). |
151
+
| All | `draft` | ❌ | If `true`, the page will not be published. |
152
+
| All | `type` |✅| Defines the content's role. Optional values: `challenge`, `learning-path`, `course`, `module`, `page`, `quiz`, or `lab`. |
153
+
| **Course** | `level`| ❌ | Thedifficulty level of the content. Optional values: `beginner`, `intermediate`, `advanced`. |
154
+
| **Learning Path** | `id` | ✅ | **Crucial.** A stable UUIDfor tracking progress. **Do not change.** [^1] |
155
+
| **Learning Path**, **Course**, **module** | `tags`| ❌ | Keywordsfor content discovery. Multiple tags can be selected. |
156
+
| **Learning Path**, **Course**, **module** | `categories`|❌ | The main categories for the content. Only one can be selected. |
157
+
| **Learning Path**, **Course** | `banner`| ❌ | Path to an image in the `static` folder, e.g., `images/icon.svg`. |
153
158
154
159
> For a complete list of all predefined variables and advanced usage, please refer to the official [Hugo FrontMatter documentation](https://gohugo.io/content-management/front-matter/).
155
160
161
+
{{< alert type="info" title="Be Careful About Name Changes" >}}
162
+
Renaming a course or module after publication would break the learning path tracking for enrolled learners. It's like changing pages while someone is following the story. Consider updating the module’s description, adding an introductory note, or creating a versioned copy.
163
+
{{< /alert >}}
164
+
156
165
## 3. Add Assets and Interactive Content
157
166
158
167
Enhance your course with images and other visual aids. The recommended and standard method for adding images is Page Bundling. This approach involves placing your image files directly alongside the Markdown content they belong to, which is simpler and keeps content organized.
@@ -163,9 +172,9 @@ For all assets, please use the Page Bundling method. It simplifies asset managem
163
172
164
173
**How to Add an Image**
165
174
166
-
1. Place your image file (e.g., `hugo-logo.png`) in the **same directory** as your Markdown file (e.g., `Chapter-1.md`).
175
+
1. Place your image file (e.g., `hugo-logo.png`) in the **same directory** as your Markdown file (e.g., `01-pods.md`).
167
176
168
-
2. In your `Chapter-1.md` file, embed the image using a **standard Markdown link**. The path should just be the filename.
177
+
2. In your `01-pods.md` file, embed the image using a **standard Markdown link**. The path should just be the filename.
169
178
170
179
```markdown
171
180
@@ -311,9 +320,6 @@ This command first deletes the local build cache (`public` directory) and then r
311
320
```bash
312
321
make clean
313
322
```
314
-
{{< alert type="info" title="Be Careful About Name Changes" >}}
315
-
Renaming a course or module after publication would break the learning path tracking for enrolled learners. It's like changing chapters while someone is following the story. Consider updating the module’s description, adding an introductory note, or creating a versioned copy.
Copy file name to clipboardExpand all lines: content/en/cloud/academy/extending-the-academy/index.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,12 +39,13 @@ You don't need to be a web developer to create beautiful and effective learning
39
39
40
40
Your content is structured hierarchically to create a clear and logical learning experience for your users.
41
41
42
-
At the highest level, you have a **Learning Path**, which serves as a container for a specific specialization or topic. Each Learning Path is made up of one or more **Courses**, and each Course is further broken down into individual **Chapters**. This modular structure makes your content easy to navigate, manage, and update.
42
+
At the highest level, you have a **Learning Path**, which contains one or more **Courses**. Each Course is broken down into **Modules**, and each Module consists of individual learning activities like **Pages** (for text), **Quizzes** (for knowledge checks), and **Labs** (for hands-on practice). This modular structure makes your content easy to navigate, manage, and update.
43
43
44
-
For example, a Learning Path titled "Mastering Kubernetes" might contain:
45
-
- A Course named "Core Concepts", which includes Chapters on "Pods", "Services", and "Deployments".
46
-
- Another Course named "Advanced Networking", with Chapters on "Ingress" and "Service Mesh".
44
+
For example, a **Learning Path** named **"Mastering Kubernetes"** might contain:
45
+
* A **Course** on **"Core Concepts"**, which is broken down into multiple modules:
46
+
* **Module 1: "Workload Fundamentals"**, containing a **Page** on the "Anatomy of a Pod" and a hands-on **Lab** for "Scaling Deployments".
47
+
* **Module 2: "Networking Principles"**, containing a **Page** that covers "Services and Ingress" and a **Quiz** on networking concepts.
To ensure security and isolation, all of your content files must be placed within a directory named for your organization UUID. You'll learn the specifics of how to do this in our [hands-on tutorial](/cloud/academy/creating-your-learning-path/).
0 commit comments