Skip to content

Commit db32d82

Browse files
authored
Merge pull request #773 from zihanKuang/update-acdemy-docs
Docs: Refactor Academy Guides and Standardize UUID Placeholders
2 parents ad39861 + 30663ad commit db32d82

4 files changed

Lines changed: 151 additions & 115 deletions

File tree

content/en/cloud/academy/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Academy
33
weight: 5
44
description: >
5-
Building, managing, and extending Layer5 Academy learning paths.
5+
Learn how to use, build, manage, and extend the Layer5 Academy.
66
categories: [Academy]
77
tags: [Academy]
88
---

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

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,40 @@ A Certification is ideal when the main objective is to test, not teach. It assum
3232

3333
Building a new certification involves setting up the correct directory structure and defining its properties through Markdown frontmatter.
3434

35+
### Find Your Organization UUID and Certification ID
36+
37+
{{< alert type="warning" title="Important: Replace UUIDs" >}}
38+
Throughout this guide, you'll see references to `<your-organization-uuid>` and `<your-certification-uuid>` placeholders. Make sure to replace all of these with your actual UUIDs from the [Instructor Console](https://cloud.layer5.io/academy/instructors-console) when implementing your certification.
39+
{{< /alert >}}
40+
41+
Each certification is tied to a specific organization and secured by a unique identifier (UUID). This is a system-generated ID that ensures your content is scoped only to your organization.
42+
43+
You'll need two types of UUIDs:
44+
- **Certification ID**: A unique identifier for your specific certification that gets added to the front matter of your certification's index file
45+
- **Organization ID**: Your organization's UUID that's used in directory paths
46+
47+
{{< alert type="info" title="Generating Your IDs from the Instructor Console" >}}
48+
49+
The easiest way to get the correct IDs is by using the content creation tool.
50+
51+
- Navigate to the [Instructor Console](https://cloud.layer5.io/academy/instructors-console) in Layer5 Cloud.
52+
- Use the "Create New Content" tool and fill in the information for your new content
53+
- The final step generates all the necessary materials to get started: the front matter, repository setup instructions, and your unique IDs.
54+
55+
[Learn more](https://cloud.layer5.io/academy/instructors-console) about the Academy Console.
56+
{{< /alert >}}
57+
3558
### 1. Set Up the Directory Structure
3659

37-
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.
60+
All content for a new certification must reside within the `content/certifications/<your-organization-uuid>` directory. To keep content organized, each certification has its own folder named with a descriptive, URL-friendly slug.
3861

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

4164
Below is the standard file structure:
4265

4366
```
44-
content/certifications/
45-
└── orgID/layer5-certification-exam/ <-- The <certification-name> directory
67+
content/certifications/<your-organization-uuid>
68+
└── layer5-certification-exam/ <-- The <certification-name> directory
4669
├── _index.md <-- Defines the certification's metadata
4770
├── exam-1.md <-- (Optional) A standard content page for introduction
4871
├── optional-exam-2.md <-- An optional supplementary exam
@@ -62,7 +85,7 @@ Here's a complete example of the YAML frontmatter for a certification's `_index.
6285
```yaml
6386
---
6487
type: "certification"
65-
id: "445a80d2-1234-1234-1234-2329c5ddcdec"
88+
id: "<your-certification-uuid>"
6689
title: "Layer5 Network Certification"
6790
description: "Validate your expertise in Layer5 networking technologies through comprehensive assessment"
6891
banner: "images/layer5-icon.svg"
@@ -80,7 +103,7 @@ categories: "platform"
80103
| Field | Required | Description |
81104
| :--- | :--- | :--- |
82105
| `type` || Must be set to `"certification"` to identify this content correctly. |
83-
| `id` || A globally unique identifier (UUID) for the certification. |
106+
| `id` || **Crucial.** A stable UUID for tracking progress. **Do not change.** |
84107
| `title` || The human-readable title that will be displayed to users. |
85108
| `description` || A comprehensive summary of the certification's scope and objectives. |
86109
| `weight` | - | Controls the display order (lower numbers appear first). Items are sorted alphabetically by title if not specified.|

0 commit comments

Comments
 (0)