Skip to content

Commit 05a7584

Browse files
committed
done
Signed-off-by: Wyllie Fang <wylliefang@gmail.com>
1 parent 9513463 commit 05a7584

1 file changed

Lines changed: 44 additions & 92 deletions

File tree

  • content/en/cloud/academy/creating-content/creating-your-learning-path

content/en/cloud/academy/creating-content/creating-your-learning-path/index.md

Lines changed: 44 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Creating Academy Content
2+
title: Creating Content for the Academy
33
weight: 3
44
description: >
55
A hands-on tutorial that walks you through creating, structuring, and testing custom content (learning paths, certifications, and challenges) for the Layer5 Academy.
@@ -8,6 +8,8 @@ tags: [Academy]
88
aliases:
99
- /cloud/academy/creating-your-learning-path/
1010
- /cloud/academy/creating-academy-content/
11+
- /cloud/academy/creating-content-for-the-academy/
12+
- /cloud/academy/creating-content-for-academy/
1113
---
1214

1315
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
6668
| Feature | Learning Path | Challenge | Certification |
6769
| :--- | :--- | :--- | :--- |
6870
| 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. |
7072
| 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. |
7173
| Outcome | Acquired knowledge and skills. | A score, rank status. | An optional, paid official certificate and a verifiable badge.|
7274

@@ -117,48 +119,50 @@ A high-level view of the learning path structure looks like this:
117119

118120
```text
119121
learning-paths/<your-organization-uuid>
120-
└── mastering-kubernetes/ // <-- Learning Path/
122+
└── {learning-path-name}/
121123
├── _index.md
122-
├── advanced-networking/ // <-- Course 1/
124+
├── course-1/
123125
│ └── _index.md
124-
└── core-concepts/ // <-- Course 2/
126+
└── course-2/
125127
├── _index.md
126-
├── course-exam.md // <-- Course Exam (Test)
127-
└── 01-pods-and-services/ // <-- Module/
128+
├── course-exam.md
129+
└── module-1/
128130
├── _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
138134
```
139135

140136
#### Certification Structure
141137
A **Certification** typically contains one or more **Exams** and optional study materials.
142138

143139
```text
144140
certifications/<your-organization-uuid>
145-
└── kubernetes-certified-admin/ // <-- Certification/
146-
├── _index.md
147-
├── exam-1.md // <-- Exam
148-
├── exam-2.md // <-- Exam (optional)
149-
└── 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/
151148
```
152149

153150
#### 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.
155152

156153
```text
157154
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}/
162166
```
163167

164168
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
171175

172176
The front matter configuration varies depending on the content type. The following examples illustrate typical setups for each content type.
173177

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:
175181

176182
```yaml
177183
---
178-
type: "learning-path"
184+
type: "learning-path" # or "certification", "challenge", "course"
179185
title: "Cloud Fundamentals"
180186
description: "A learning path focused on providing the technical knowledge required for advanced topics."
181187
weight: 5
@@ -185,64 +191,10 @@ tags: [kubernetes, infrastructure]
185191
categories: "cloud"
186192
level: "beginner"
187193
badge:
188-
png: "https://images.credly.com/images/f28f1d88-428a-47f6-95b5-7da1dd6c1000/twitter_thumb_201604_KCNA_badge.png"
189-
svg: "https://images.credly.com/images/f28f1d88-428a-47f6-95b5-7da1dd6c1000/twitter_thumb_201604_KCNA_badge.png"
190-
title: "Layer5 Certified"
191-
description: "Earn the Certification badge to showcase your expertise in Layer5 cloud services."
192-
---
193-
```
194-
195-
#### Certification Frontmatter
196-
197-
```yaml
198-
---
199-
type: "certification"
200-
title: "Kubernetes Certified Administrator"
201-
description: "Official certification for Kubernetes administration expertise."
202-
weight: 1
203-
banner: "k8s-cert-icon.svg"
204-
id: "<your-content-uuid>"
205-
tags: [kubernetes, certification]
206-
categories: "infrastructure"
207-
level: "advanced"
208-
badge:
209-
png: "certification-badge.png"
210-
svg: "certification-badge.svg"
211-
title: "Kubernetes Admin Certified"
212-
description: "Validates your expertise in Kubernetes administration."
213-
---
214-
```
215-
216-
#### Challenge Frontmatter
217-
218-
```yaml
219-
---
220-
type: "challenge"
221-
title: "Kubernetes Troubleshooting Challenge"
222-
description: "Solve real-world Kubernetes issues in a competitive scenario."
223-
weight: 1
224-
banner: "challenge-icon.svg"
225-
id: "<your-content-uuid>"
226-
tags: [kubernetes, troubleshooting]
227-
categories: "infrastructure"
228-
level: "intermediate"
229-
---
230-
```
231-
232-
#### Course Frontmatter
233-
234-
If each course has its own markdown page, you can use this frontmatter:
235-
236-
```yaml
237-
---
238-
type: "course"
239-
title: "Intro Sustainability"
240-
description: "An introductory course exploring the core concepts of sustainability."
241-
weight: 2
242-
banner: "kubernetes-icon.svg"
243-
tags: [network, infrastructure]
244-
level: "beginner"
245-
categories: "compliance"
194+
png: "https://images.credly.com/images/f28f1d88-428a-47f6-95b5-7da1dd6c1000/twitter_thumb_201604_KCNA_badge.png"
195+
svg: "https://images.credly.com/images/f28f1d88-428a-47f6-95b5-7da1dd6c1000/twitter_thumb_201604_KCNA_badge.png"
196+
title: "Layer5 Certified"
197+
description: "Earn the Certification badge to showcase your expertise in Layer5 cloud services."
246198
---
247199
```
248200

@@ -258,11 +210,11 @@ categories: "compliance"
258210
| All | `draft` | - | If `true`, the page will not be published. |
259211
| All | `type` || Defines the content's role. Values: `challenge`, `learning-path`, `certification`, `course`, `module`, `page`, `test`, or `lab`. |
260212
| **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. |
266218

267219

268220
> 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

Comments
 (0)