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/images/embedded-design-academy-content-publishing-workflow.js
Copy file name to clipboardExpand all lines: content/en/cloud/academy/creating-your-learning-path/index.md
+76-36Lines changed: 76 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ categories: [Academy]
7
7
tags: [Designer]
8
8
---
9
9
10
-
This guide provides a step-by-step walkthrough for creating and organizing a new learning path in the [Layer5 Academy](https://cloud.layer5.io/academy/overview). You'll learn how to set up your content repository, structure your courses, add assets, preview your work, and publish it for your organization.
10
+
This guide provides a step-by-step walkthrough for creating and organizing a new learning path in the [Layer5 Academy](https://cloud.layer5.io/academy/content). You'll learn how to set up your content repository, structure your courses, add assets, preview your work, and publish it for your organization.
11
11
12
12
### Prerequisites
13
13
@@ -74,10 +74,8 @@ You can find and copy your Organization UUID from your organization page on [Lay
This `content` directory is where all your written material lives. The folder hierarchy you create here directly defines the navigation and organization of your learning paths.
77
-
2. `static/<your-organization-uid>/`
78
-
This `static` directory is for all your assets, such as images, diagrams, and so on.
79
-
3. `layouts/shortcodes/<your-organization-uid>/`
80
-
This `layouts` directory is for advanced use. You can place custom **Hugo Shortcodes** here if you need special reusable components in your Chapters.
77
+
2. `layouts/shortcodes/<your-organization-uid>/`
78
+
This `layouts` directory is for advanced use. You can place custom **Hugo Shortcodes** here if you need special reusable components.
81
79
82
80
3. **Build the Content Hierarchy**
83
81
@@ -97,6 +95,7 @@ You can find and copy your Organization UUID from your organization page on [Lay
97
95
├── _index.md
98
96
├── 01-pods.md // <-- Chapter 1
99
97
└── 02-services.md // <-- Chapter 2
98
+
└── arch.png // <-- Image
100
99
```
101
100
102
101
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.
@@ -109,48 +108,48 @@ You can find and copy your Organization UUID from your organization page on [Lay
109
108
110
109
```yaml
111
110
---
112
-
title: "Mastering Kubernetes for Engineers"
113
-
description: "Learn how to configure your Kubernetes clusters and manage the lifecycle of your workloads"
114
-
banner: null # Optional, URL to banner image
111
+
title: "Advanced Course"
112
+
description: "This ADVANCED - Course is where to get the technical knowledge."
113
+
weight: 5
114
+
banner: "images/exoscale-icon.svg"
115
+
id: "754627a3-7993-4b01-a7f0-c66c0212a1a1"
116
+
tags: [orchestration]
117
+
categories: [introductory]
115
118
---
116
119
```
117
120
118
121
> Place this frontmatter in the Markdown file that represents the learning path index page.
When using the `banner` field in your frontmatter, always provide the full, static path to your image. This path must start with your OrganizationUUID; for example: `/org_id/images/kubernetes-icon.svg`.
| All | `description` | ✅ | A brief summary of the content. |
145
+
| All | `weight` | ✅ | Controls the display order (lower numbers appear first). |
146
+
| All | `banner` | ❌ | Path to an image in the `static` folder, e.g., `images/icon.svg`. |
147
+
| All | `tags` | ❌ | Keywords for content discovery. |
148
+
| All | `categories` | ❌ | The main categories for the content. |
149
+
| All | `draft` | ❌ | If `true`, the page will not be published. |
150
+
| **Learning Path** | `id` | ✅ | **Crucial.** A stable UUID for tracking progress. **Do not change.** [^1]|
151
+
| **Course** | `id` | ❌ | A simple, human-readable string identifier for the course. |
152
+
| **Course** | `prerequisites` | ❌ | Optional list of prerequisites for the course. |
154
153
155
154
> 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/).
156
155
@@ -173,7 +172,7 @@ For all assets, please use the Page Bundling method. It simplifies asset managem
173
172
```
174
173
175
174
{{< alert type="warning" title="Legacy Method: Do Not Use" >}}
176
-
The `usestatic` shortcode is **deprecated** and should not be usedfor new courses.
175
+
The `usestatic` shortcode is **deprecated** and should not be used!
177
176
{{< /alert >}}
178
177
179
178
**How to Add a Video**
@@ -200,14 +199,20 @@ This will start a local development server, where you can view your learning pat
200
199
201
200
202
201
{{< alert type="info" title="Local Previews" >}}
203
-
The local preview uses a generic theme to show the structure and content of your learning path. It **will not** display your organization's specific branding, such as custom logos or color schemes. The full, branded experience will only be visible after your content is published to the Layer5 Academy platform.
202
+
The local preview uses a generic theme to show the structure and content of your learning path. It **will not** display your organization's specific branding, such as custom logos or color schemes.
204
203
205
204
You can configure your organization's branding in the [Layer5 Cloud Organization Settings](https://cloud.layer5.io/identity/organizations).
206
205
{{< /alert >}}
207
206
208
207
## 5. Publishing Your Learning Path
209
208
210
-
Once you have tested your content locally, you can publish it to the [Layer5 Academy](https://cloud.layer5.io/academy/overview) through our automated workflow. The process involves a one-time setup of secrets and then creating a GitHub Release to publish each new version.
209
+
Once you have tested your content locally, you can publish it to the [Layer5 Academy](https://cloud.layer5.io/academy/content) through our automated workflow.
210
+
211
+
To help you visualize how your content goes from a local file to a live learning path, the diagram below illustrates the entire end-to-end publishing workflow. It shows which components you will interact with directly and how the CI/CD pipeline handles the rest automatically.
The process involves a one-time setup of secrets in your repository, followed by creating a GitHub Release to publish each new version of your content.
211
216
212
217
### Stage 1: Configure the Publishing Workflow (One-Time Setup)
213
218
@@ -265,7 +270,7 @@ With the setup complete, you can publish your content anytime by creating a new
265
270
5. Provide a title and description for your release.
266
271
6. Click **"Publish release"**.
267
272
268
-
This action will automatically trigger the workflow, and your content will be deployed to the [Layer5 Academy](https://cloud.layer5.io/identity/overview).
273
+
This action will automatically trigger the workflow, and your content will be deployed to the [Layer5 Academy](https://cloud.layer5.io/academy/content).
269
274
270
275
- Your content will be available in the [staging environment](https://staging-cloud.layer5.io/) within approximately 10 minutes.
271
276
- Your content will go fully live to the production Academy platform during the next scheduled cloud release.
@@ -274,6 +279,39 @@ This action will automatically trigger the workflow, and your content will be de
274
279
275
280
276
281
282
+
## 6. Ongoing Maintenance and Updates
283
+
284
+
Once your learning path is live, you may need to perform routine tasks to keep your local environment and dependencies up-to-date.
285
+
286
+
### Updating the Academy Theme
287
+
The [`academy-theme`](https://github.com/layer5io/academy-theme) provides the core layout, style, and features for your learning path. Regularly updating it ensures you benefit from the latest improvements and bug fixes.
288
+
289
+
To upgrade to the latest theme version, run:
290
+
```bash
291
+
make theme-upgrade
292
+
```
293
+
294
+
You will see output similar to this as Hugo fetches the new modules:
It's a good practice to update the theme before creating a new release or when you notice that your local preview is missing recent design changes.
305
+
{{< /alert >}}
306
+
307
+
### Clearing the LocalCacheforTroubleshooting
308
+
309
+
If you encounter unexpected formatting issues or your content doesn't update correctly during local development, your build cache might be stale. Use the `make clean` command to resolve this.
310
+
This command first deletes the local build cache (`public` directory) and then restarts the development server, ensuring you are previewing a fresh build of your content.
311
+
```bash
312
+
make clean
313
+
```
314
+
277
315
## Frequently Asked Questions
278
316
279
317
1. **Why is my workflow failing with a `401 Unauthorized` or `user must be logged in` error?**
@@ -295,3 +333,5 @@ This action will automatically trigger the workflow, and your content will be de
295
333
5. **How do I structure multiple courses under one learning path?**
296
334
297
335
The structure is defined by your folder hierarchy. A learning path is a directory, and each course is a sub-directory within that path. This folder structure in your `content` directory directly maps to the learning path structure presented to users.
336
+
337
+
[^1]: The auto-generated learning path ID feature will be launched soon.
Copy file name to clipboardExpand all lines: content/en/cloud/academy/extending-the-academy/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ categories: [Academy]
7
7
tags: [Designer]
8
8
---
9
9
10
-
The [Layer5 Cloud Academy](https://cloud.layer5.io/academy/overview) is a modular learning management system (LMS) designed for building learning paths and interactive, hands-on challenges. It is deeply integrated into the Layer5 cloud ecosystem and **[Kanvas](https://kanvas.new/)** — a visual designer for cloud native infrastructure. This integration allows you to embed live visualizations, interactive designs, and contextual experiences directly into your courses.
10
+
The [Layer5 Cloud Academy](https://cloud.layer5.io/academy/content) is a modular learning management system (LMS) designed for building learning paths and interactive, hands-on challenges. It is deeply integrated into the Layer5 cloud ecosystem and **[Kanvas](https://kanvas.new/)** — a visual designer for cloud native infrastructure. This integration allows you to embed live visualizations, interactive designs, and contextual experiences directly into your courses.
11
11
12
12
This approach transforms learning from passive reading into active, hands-on practice.
0 commit comments