Skip to content

Commit d807068

Browse files
committed
updaye-academy-docs
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
1 parent b1b745c commit d807068

File tree

4 files changed

+194
-37
lines changed

4 files changed

+194
-37
lines changed

content/en/cloud/academy/creating-your-learning-path/images/embedded-design-academy-content-publishing-workflow.js

Lines changed: 150 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

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

Lines changed: 42 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ categories: [Academy]
77
tags: [Designer]
88
---
99

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.
1111

1212
### Prerequisites
1313

@@ -74,10 +74,8 @@ You can find and copy your Organization UUID from your organization page on [Lay
7474
7575
1. `content/learning-paths/<your-organization-uid>/`
7676
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.
8179
8280
3. **Build the Content Hierarchy**
8381
@@ -97,6 +95,7 @@ You can find and copy your Organization UUID from your organization page on [Lay
9795
├── _index.md
9896
├── 01-pods.md // <-- Chapter 1
9997
└── 02-services.md // <-- Chapter 2
98+
└── arch.png // <-- Image
10099
```
101100
102101
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
109108
110109
```yaml
111110
---
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]
115118
---
116119
```
117120
118121
> Place this frontmatter in the Markdown file that represents the learning path index page.
119122
120123
**Course Frontmatter (Optional Individual Course Pages)**
121124
122-
If each course has its own markdown page, you can use this frontmatter:
125+
If each course has its own markdown page, you can use this frontmatter:
123126
124127
```yaml
125128
---
126-
title: "Kubernetes Basics"
127-
description: "Learn the basics of Kubernetes"
128-
weight: 1
129-
banner: null # Optional
129+
id: "Networks"
130+
title: "Networks"
131+
description: "This course clear your Network concept"
132+
weight: 2
133+
banner: "images/kubernetes-icon.svg"
134+
tags: [network]
135+
categories: [introductory]
130136
---
131137
```
132138
133139
**Summary of Required Fields**
134140
135-
| Type | Field | Required | Notes |
136-
| ------------- | ------------- | -------- | --------------------------- |
137-
| Learning Path | `title` | ✅ | |
138-
| | `description` | ✅ | |
139-
| | `weight` | ✅ | Order in path, lower first |
140-
| | `banner` | ❌ | Optional image URI |
141-
| Course | `title` | ✅ | |
142-
| | `description` | ✅ | |
143-
| | `weight` | ✅ | Order in path |
144-
| | `banner` | ❌ | Optional image URI |
145-
| | `prerequisites` | ❌ | Optional List of prerequisites for the course |
146-
| | `draft` | ❌ | Skips build, won't appear|
147-
| | `tags` | ❌ | Keywords for content |
148-
| | `categories` | ❌ | Main content categories |
149-
150-
151-
{{< alert type="warning" title="Banner Image Paths" >}}
152-
When using the `banner` field in your frontmatter, always provide the full, static path to your image. This path must start with your Organization UUID; for example: `/org_id/images/kubernetes-icon.svg`.
153-
{{< /alert >}}
141+
| Applicable To | Field | Required | Notes |
142+
| --------------- | ------------- | :------: | -------------------------------------------------------------------------- |
143+
| All | `title` | ✅ | The main display title. |
144+
| 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. |
154153
155154
> 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/).
156155
@@ -173,7 +172,7 @@ For all assets, please use the Page Bundling method. It simplifies asset managem
173172
```
174173
175174
{{< alert type="warning" title="Legacy Method: Do Not Use" >}}
176-
The `usestatic` shortcode is **deprecated** and should not be used for new courses.
175+
The `usestatic` shortcode is **deprecated** and should not be used!
177176
{{< /alert >}}
178177
179178
**How to Add a Video**
@@ -200,14 +199,20 @@ This will start a local development server, where you can view your learning pat
200199
![Preview site](./images/preview-site.png)
201200
202201
{{< 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.
204203

205204
You can configure your organization's branding in the [Layer5 Cloud Organization Settings](https://cloud.layer5.io/identity/organizations).
206205
{{< /alert >}}
207206
208207
## 5. Publishing Your Learning Path
209208
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.
212+
213+
{{< meshery-design-embed src="..//creating-your-learning-path/images/embedded-design-academy-content-publishing-workflow.js" id="embedded-design-37c37d14-be76-487a-90aa-5ada0c1c115f" size="full" >}}
214+
215+
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.
211216
212217
### Stage 1: Configure the Publishing Workflow (One-Time Setup)
213218
@@ -295,3 +300,5 @@ This action will automatically trigger the workflow, and your content will be de
295300
5. **How do I structure multiple courses under one learning path?**
296301
297302
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.
303+
304+
[^1]: The auto-generated learning path ID feature will be launched soon.

content/en/cloud/academy/extending-the-academy/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ categories: [Academy]
77
tags: [Designer]
88
---
99

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.
1111

1212
This approach transforms learning from passive reading into active, hands-on practice.
1313

layouts/partials/navbar.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
<div class="dropdown-menu dropdown-menu--col" aria-labelledby="resourcesDropdown" style="visibility:hidden;">
4040
<a
4141
class="dropdown-item dropdown-item--row"
42-
href="https://cloud.layer5.io/academy/overview"
42+
href="https://cloud.layer5.io/academy/content"
4343
target="_blank"
4444
>
4545
<div class="logo-container">

0 commit comments

Comments
 (0)