Skip to content

Commit ca21ccc

Browse files
authored
Merge pull request #758 from zihanKuang/update-banner-position
docs: Update banner path and table fields
2 parents e83890f + b1b646d commit ca21ccc

File tree

1 file changed

+10
-6
lines changed
  • content/en/cloud/academy/creating-content/creating-your-learning-path

1 file changed

+10
-6
lines changed

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,11 @@ You can find and copy your Organization UUID from your organization page on [Aca
122122
title: "Cloud Fundamentals"
123123
description: "A learning path focused on providing the technical knowledge required for advanced topics."
124124
weight: 5
125-
banner: "images/kubernetes-icon.svg"
125+
banner: "kubernetes-icon.svg"
126126
id: "754627a3-2323-4545-a7f0-c66c0212a1a1"
127127
tags: [kubernetes, infrastructure]
128128
categories: "cloud"
129+
level: "beginner"
129130
---
130131
```
131132
@@ -139,29 +140,29 @@ You can find and copy your Organization UUID from your organization page on [Aca
139140
title: "Intro Sustainability"
140141
description: "An introductory course exploring the core concepts of sustainability."
141142
weight: 2
142-
banner: "images/kubernetes-icon.svg"
143+
banner: "kubernetes-icon.svg"
143144
tags: [network, infrastructure]
144145
level: "beginner"
145146
categories: "compliance"
146147
---
147148
```
148-
149-
> In this table, fields marked with ✅ are required, while those marked with – are optional.
150149
151150
**Summary of Required Fields**
152151
152+
> In this table, fields marked with ✅ are required, while those marked with – are optional.
153+
153154
| Applicable To | Field | Required | Notes |
154155
| ----------------------------- | ------------- | :------: | ------------------------------------------------------------------------------------------------------------- |
155156
| All | `title` | ✅ | The main display title. |
156157
| All | `description` | ✅ | A brief summary of the content. |
157158
| All | `weight` | - | Controls the display order (lower numbers appear first). Items are sorted alphabetically by title if not specified.|
158159
| All | `draft` | - | If `true`, the page will not be published. |
159160
| All | `type` | ✅ | Defines the content's role. Optional values: `challenge`, `learning-path`, `certification`, `course`, `module`, `page`, `test`, or `lab`. |
160-
| **Course** | `level` | - | A string for the intended difficulty (`beginner`, `intermediate`, `advanced`). Default: `beginner`. |
161+
| **Learning Path**, **Course** | `level` | - | A string for the intended difficulty (`beginner`, `intermediate`, `advanced`). Default: `beginner`. |
161162
| **Learning Path** | `id` | ✅ | **Crucial.** A stable UUID for tracking progress. **Do not change.** [^1] |
162163
| **Learning Path**, **Course**, **module** | `tags` | - | Keywords for content discovery. Multiple tags can be selected. |
163164
| **Learning Path**, **Course**, **module** | `categories` | - | The main categories for the content. Only one can be selected. |
164-
| **Learning Path**, **Course** | `banner` | - | Path to an image in the `static` folder, e.g., `images/icon.svg`. |
165+
| **Learning Path**, **Course** | `banner` | - | Path to a banner image located in the same folder (Page Bundle). |
165166

166167
> 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/).
167168

@@ -243,6 +244,9 @@ For optimal performance, we recommend hosting large videos on dedicated platform
243244
Before publishing, it is crucial to preview your content locally to check for formatting errors, broken links, and overall structure.
244245

245246
```bash
247+
# Set Up the Environment (One-time Task)
248+
make setup
249+
# Run the Local Preview Server
246250
make site
247251
```
248252

0 commit comments

Comments
 (0)