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-content/creating-your-learning-path/index.md
+44-92Lines changed: 44 additions & 92 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Creating Academy Content
2
+
title: Creating Content for the Academy
3
3
weight: 3
4
4
description: >
5
5
A hands-on tutorial that walks you through creating, structuring, and testing custom content (learning paths, certifications, and challenges) for the Layer5 Academy.
This guide provides a step-by-step walkthrough for creating and organizing new content in the [Layer5 Academy](https://cloud.layer5.io/academy). You'll learn how to set up your content repository, structure your content, add assets, preview your work, and publish it for your organization.
@@ -66,7 +68,7 @@ The Academy supports three distinct content types, each designed for specific ed
| Primary Goal | To teach and guide through a comprehensive curriculum. | To solve a specific, hands-on problem in a competitive scenario. | To validate and prove existing knowledge through formal examination. |
69
-
| Structure | Hierarchical (Path → Courses → Modules). | Typically a single, scenario-based task. | Flat; a collection of one or more exams. |
71
+
| Structure | Hierarchical (Learning Path → Courses → Modules). | Typically a single, scenario-based task. | Flat; a collection of one or more exams. |
70
72
| Main Content | Lessons, informational pages, labs, and progressive assessments. | A set of instructions for a practical task and a validation mechanism. | A series of exams, potentially with a brief study guide. |
71
73
| Outcome | Acquired knowledge and skills. | A score, rank status. | An optional, paid official certificate and a verifiable badge.|
72
74
@@ -117,48 +119,50 @@ A high-level view of the learning path structure looks like this:
117
119
118
120
```text
119
121
learning-paths/<your-organization-uuid>
120
-
└── mastering-kubernetes/ // <-- Learning Path/
122
+
└── {learning-path-name}/
121
123
├── _index.md
122
-
├── advanced-networking/ // <-- Course 1/
124
+
├── course-1/
123
125
│ └── _index.md
124
-
└── core-concepts/ // <-- Course 2/
126
+
└── course-2/
125
127
├── _index.md
126
-
├── course-exam.md // <-- Course Exam (Test)
127
-
└── 01-pods-and-services/ // <-- Module/
128
+
├── course-exam.md
129
+
└── module-1/
128
130
├── _index.md
129
-
├── 01-pods/
130
-
│ └── _index.md // <-- Page 1
131
-
├── 02-services/
132
-
│ ├── _index.md // <-- Page 2
133
-
│ ├── 02-image.png // <-- Image
134
-
├── 03-knowledge-check.md // <-- Test
135
-
├── 04-hands-on-lab.md // <-- Lab
136
-
└── arch.png // <-- Image
137
-
131
+
├── page-1/
132
+
│ └── _index.md
133
+
├── test.md
138
134
```
139
135
140
136
#### Certification Structure
141
137
A **Certification** typically contains one or more **Exams** and optional study materials.
└── study-guide/ // <-- Study materials (optional)
150
-
└── _index.md
141
+
└── {certification-name}/
142
+
├── _index.md
143
+
├── exam/
144
+
│ ├── _index.md
145
+
├── test-1/
146
+
├── test-2/
147
+
└── test-3/
151
148
```
152
149
153
150
#### Challenge Structure
154
-
A **Challenge** is typically a single scenario-based task with instructions and validation.
151
+
A **Challenge** is typically a single scenario-based task with lab and exam components.
155
152
156
153
```text
157
154
challenges/<your-organization-uuid>
158
-
└── kubernetes-troubleshooting/ // <-- Challenge/
159
-
├── _index.md
160
-
├── scenario.md // <-- Challenge instructions
161
-
└── validation.md // <-- Validation criteria
155
+
└── {challenge-name}/
156
+
├── _index.md
157
+
├── lab/
158
+
│ ├── _index.md
159
+
├── exam/
160
+
│ ├── _index.md
161
+
└── content/
162
+
├── description/
163
+
├── getting-started/
164
+
├── faq/
165
+
└── {other-sections}/
162
166
```
163
167
164
168
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"`, `type: "certification"`, or `type: "challenge"`). The final `.md` files represent your individual learning activities.
@@ -171,11 +175,13 @@ Front matter is the configuration block at the top of every content file that de
171
175
172
176
The front matter configuration varies depending on the content type. The following examples illustrate typical setups for each content type.
173
177
174
-
#### Learning Path Frontmatter
178
+
#### Frontmatter
179
+
180
+
All `_index.md` files use the same frontmatter structure. Only the `type` field differs based on the content level:
175
181
176
182
```yaml
177
183
---
178
-
type: "learning-path"
184
+
type: "learning-path"# or "certification", "challenge", "course"
179
185
title: "Cloud Fundamentals"
180
186
description: "A learning path focused on providing the technical knowledge required for advanced topics."
description: "Earn the Certification badge to showcase your expertise in Layer5 cloud services."
246
198
---
247
199
```
248
200
@@ -258,11 +210,11 @@ categories: "compliance"
258
210
| All |`draft`| - | If `true`, the page will not be published. |
259
211
| All |`type`| ✅ | Defines the content's role. Values: `challenge`, `learning-path`, `certification`, `course`, `module`, `page`, `test`, or `lab`. |
260
212
|**Learning Path**, **Certification**, **Challenge**|`id`| ✅ |**Crucial.** A stable UUID for tracking progress. **Do not change.**|
261
-
|**Learning Path**, **Certification**|`badge`| - | Defines the awarded digital badge. The png and svg fields accept either a full remote URL or a local file path for an image in the same folder (e.g., layer5-badge.svg).|
262
-
|**Learning Path**, **Certification**, **Challenge**, **Course**|`level`| - | A string for the intended difficulty (`beginner`, `intermediate`, `advanced`). Default: `beginner`. |
263
-
|**Learning Path**, **Certification**, **Challenge**, **Course**|`banner`| - | Path to a banner image located in the same folder (Page Bundle). |
264
-
|**Learning Path**, **Certification**, **Challenge**, **Course**, **Module**|`tags`| - | Keywords for content discovery. Multiple tags can be selected. |
265
-
|**Learning Path**, **Certification**, **Challenge**, **Course**, **Module**|`categories`| - | The main categories for the content. Only one can be selected. |
213
+
|**Learning Path**, **Certification**, **Challenge**|`badge`| - | Defines the awarded digital badge. The png and svg fields accept either a full remote URL or a local file path for an image in the same folder (e.g., meshery-contributor-badge.svg).|
214
+
|**Learning Path**, **Certification**, **Challenge**|`level`| - | A string for the intended difficulty (`beginner`, `intermediate`, `advanced`). Default: `beginner`. |
215
+
|**Learning Path**, **Certification**, **Challenge**|`banner`| - | Path to a banner image located in the same folder (Page Bundle). |
216
+
|All|`tags`| - | Keywords for content discovery. Multiple tags can be selected. |
217
+
|All|`categories`| - | The main categories for the content. Only one can be selected. |
266
218
267
219
268
220
> For a complete list of all predefined variables and advanced usage, please refer to the official [Hugo Front Matter documentation](https://gohugo.io/content-management/front-matter/).
0 commit comments