Skip to content

Commit f61d49b

Browse files
zihanKuangzihanKuang
committed
update
Signed-off-by: ZihanKuang <[email protected]>
1 parent a8740b7 commit f61d49b

File tree

5 files changed

+45
-38
lines changed

5 files changed

+45
-38
lines changed

‎content/en/cloud/academy/creating-content/building-certifications/images/badge.png

679 Bytes
Loading

‎content/en/cloud/academy/creating-content/building-certifications/images/index-page.png

43 KB
Loading

‎content/en/cloud/academy/creating-content/building-certifications/index.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -36,17 +36,17 @@ Building a new certification involves setting up the correct directory structure
3636

3737
All content for a new certification must reside within the `content/certifications/orgID` directory. To keep content organized, each certification has its own folder named with a descriptive, URL-friendly slug.
3838

39-
The final URL will follow this pattern: `https://cloud.layer5.io/academy/content/certifications/<certification-folder-name>/`
39+
The final URL will follow this pattern: `https://cloud.layer5.io/academy/content/certifications/orgID/<certification-folder-name>/`
4040

4141
Below is the standard file structure:
4242

4343
```
4444
content/certifications/
45-
└── orgID/layer5-certification-exam/ <-- The <certification-name> directory
46-
├── _index.md <-- Defines the certification's metadata
47-
├── exam-1.md <-- (Optional) A standard content page for introduction
48-
├── optional-exam-2.md <-- An optional supplementary exam
49-
└── exam-3.md <-- A mandatory exam, accessible after completing all previous required units.
45+
└── orgID/layer5-certification-exam/ <-- The <certification-name> directory
46+
├── _index.md <-- Defines the certification's metadata
47+
├── exam-1.md <-- (Optional) A standard content page for introduction
48+
├── optional-exam-2.md <-- An optional supplementary exam
49+
└── exam-3.md <-- A mandatory exam, accessible after completing all previous required units.
5050
```
5151

5252
**Key Files:**
@@ -75,17 +75,19 @@ categories: "platform"
7575

7676
#### Frontmatter Fields Reference
7777

78+
> In this table, fields marked with ✅ are required, while those marked with – are optional.
79+
7880
| Field | Required | Description |
7981
| :--- | :--- | :--- |
80-
| `type` | ✅ | Must be set to `"certification"` to identify this content correctly. |
81-
| `id` | ✅ | A globally unique identifier (UUID) for the certification. |
82-
| `title` | ✅ | The human-readable title that will be displayed to users. |
83-
| `description` | ✅ | A comprehensive summary of the certification's scope and objectives. |
84-
| `weight` | ❌ | Controls the display order (lower numbers appear first). Items are sorted alphabetically by title if not specified.|
85-
| `banner` | ❌ | Path to an image in the `static` folder, e.g., `images/icon.svg`. |
86-
| `tags` | ❌ | Keywords for content discovery. Multiple tags can be selected. |
87-
| `level` | ❌ | A string for the intended difficulty (`beginner`, `intermediate`, `advanced`). Default: `beginner`. |
88-
| `categories` | ❌ | A string that assigns the certification to a specific category. |
82+
| `type` | ✅ | Must be set to `"certification"` to identify this content correctly. |
83+
| `id` | ✅ | A globally unique identifier (UUID) for the certification. |
84+
| `title` | ✅ | The human-readable title that will be displayed to users. |
85+
| `description` | ✅ | A comprehensive summary of the certification's scope and objectives. |
86+
| `weight` | - | Controls the display order (lower numbers appear first). Items are sorted alphabetically by title if not specified.|
87+
| `banner` | - | Path to an image in the `static` folder, e.g., `images/icon.svg`. |
88+
| `tags` | - | Keywords for content discovery. Multiple tags can be selected. |
89+
| `level` | - | A string for the intended difficulty (`beginner`, `intermediate`, `advanced`). Default: `beginner`. |
90+
| `categories` | - | A string that assigns the certification to a specific category. |
8991

9092
### 3. Add Content and Exams
9193

@@ -108,6 +110,8 @@ Successfully completing a certification provides learners with valuable, verifia
108110

109111
Upon successful completion of all mandatory exams, learners are awarded a digital badge. This badge serves as a verifiable credential that is perfect for sharing on professional profiles to showcase the achievement.
110112

113+
See a live example on a [user's profile](https://cloud.layer5.io/user/a5eb9e0a-c9e3-4b66-890c-8f018e729306?tab=badges)
114+
111115
![example badge image](./images/badge.png)
112116

113117
### Official Certificates

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

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -146,20 +146,21 @@ You can find and copy your Organization UUID from your organization page on [Aca
146146
---
147147
```
148148
149+
> In this table, fields marked with ✅ are required, while those marked with – are optional.
149150
**Summary of Required Fields**
150151
151152
| Applicable To | Field | Required | Notes |
152153
| ----------------------------- | ------------- | :------: | ------------------------------------------------------------------------------------------------------------- |
153-
| All | `title` | ✅ | The main display title. |
154-
| All | `description` | ✅ | A brief summary of the content. |
155-
| All | `weight` | ✅ | Controls the display order (lower numbers appear first). |
156-
| All | `draft` | ❌ | If `true`, the page will not be published. |
157-
| All | `type` | ✅ | Defines the content's role. Optional values: `challenge`, `learning-path`, `course`, `module`, `page`, `test`, or `lab`. |
158-
| **Course** | `level` | ❌ | The difficulty level of the content. Optional values: `beginner`, `intermediate`, `advanced`. |
159-
| **Learning Path** | `id` | ✅ | **Crucial.** A stable UUID for tracking progress. **Do not change.** [^1] |
160-
| **Learning Path**, **Course**, **module** | `tags` | ❌ | Keywords for content discovery. Multiple tags can be selected. |
161-
| **Learning Path**, **Course**, **module** | `categories` | ❌ | The main categories for the content. Only one can be selected. |
162-
| **Learning Path**, **Course** | `banner` | ❌ | Path to an image in the `static` folder, e.g., `images/icon.svg`. |
154+
| All | `title` | ✅ | The main display title. |
155+
| All | `description` | ✅ | A brief summary of the content. |
156+
| All | `weight` | - | Controls the display order (lower numbers appear first). Items are sorted alphabetically by title if not specified.|
157+
| All | `draft` | - | If `true`, the page will not be published. |
158+
| All | `type` | ✅ | Defines the content's role. Optional values: `challenge`, `learning-path`, `certification`, `course`, `module`, `page`, `test`, or `lab`. |
159+
| **Course** | `level` | - | A string for the intended difficulty (`beginner`, `intermediate`, `advanced`). Default: `beginner`. |
160+
| **Learning Path** | `id` | ✅ | **Crucial.** A stable UUID for tracking progress. **Do not change.** [^1] |
161+
| **Learning Path**, **Course**, **module** | `tags` | - | Keywords for content discovery. Multiple tags can be selected. |
162+
| **Learning Path**, **Course**, **module** | `categories` | - | The main categories for the content. Only one can be selected. |
163+
| **Learning Path**, **Course** | `banner` | - | Path to an image in the `static` folder, e.g., `images/icon.svg`. |
163164

164165
> 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/).
165166

‎content/en/cloud/academy/creating-content/integrating-assessments-in-the-academy/index.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -130,21 +130,23 @@ questions:
130130

131131
### Assessment Frontmatter Fields
132132

133+
> In this table, fields marked with ✅ are required, while those marked with – are optional.
134+
133135
| Applicable To | Field | Required | Description |
134136
| :--- | :--- | :--- | :--- |
135-
| **Assessment** | `title` | No | A short, descriptive name for the assessment (e.g., "Final Exam" or "Module 3 Quiz"). |
136-
| | `id` | No | Unique identifier for the assessment. If omitted, a UUID will be auto-generated. |
137-
| | `passing_percentage` | Yes | Minimum score required to pass the assessment (e.g., `70`). |
138-
| | `type` | Yes | Metadata type for the assessment. The value must be `test`. |
139-
| | `layout` | No | Metadata type for the assessment. The value must be `test`. |
140-
| | `is_optional` | No | A boolean value. If `true`, the assessment can be skipped without affecting completion. |
141-
| | `final` | No | A boolean flag. Set to `true` if this assessment determines the completion for its parent course or path. |
142-
| | `questions` | Yes | An array containing one or more question objects. |
143-
| **Question Object** | `id` | Yes | Unique identifier for the question within the assessment (e.g., `q1`, `q2`). |
144-
| | `text` | Yes | The text of the question prompt. |
145-
| | `type` | Yes | The type of question. Accepted values are `single-answer`, `multiple-answers` or `short_answer`. |
146-
| | `marks` | Yes | The number of points awarded for a correct answer. |
147-
| | `options` | No | An array of answer options. |
137+
| **Assessment** | `title` | - | A short, descriptive name for the assessment (e.g., "Final Exam" or "Module 3 Quiz"). |
138+
| | `id` | - | Unique identifier for the assessment. If omitted, a UUID will be auto-generated. |
139+
| | `passing_percentage` | ✅ | Minimum score required to pass the assessment (e.g., `70`). |
140+
| | `type` | ✅ | Metadata type for the assessment. The value must be `test`. |
141+
| | `layout` | - | Metadata type for the assessment. The value must be `test`. |
142+
| | `is_optional` | - | A boolean value. If `true`, the assessment can be skipped without affecting completion. |
143+
| | `final` | - | A boolean flag. Set to `true` if this assessment determines the completion for its parent course or path. |
144+
| | `questions` | ✅ | An array containing one or more question objects. |
145+
| **Question Object** | `id` | ✅ | Unique identifier for the question within the assessment (e.g., `q1`, `q2`). |
146+
| | `text` | ✅ | The text of the question prompt. |
147+
| | `type` | ✅ | The type of question. Accepted values are `single-answer`, `multiple-answers` or `short_answer`. |
148+
| | `marks` | ✅ | The number of points awarded for a correct answer. |
149+
| | `options` | - | An array of answer options. |
148150

149151
{{< alert type="warning" title="Quick heads up" >}}
150152
Remember: `type: "test"` are fixed values that cannot be modified. The system needs these exact words to work properly.

0 commit comments

Comments
 (0)