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/index.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -50,23 +50,23 @@ This step is essential. It updates your repository's "identity card" (`go.mod`)
50
50
51
51
The Academy uses a specific directory layout to keep each organization's content separate and secure.
52
52
53
-
1. **Define Your Unique Identifier**
53
+
1. **Get Your Organization ID**
54
54
55
-
First, you'll need a unique identifier foryour organization. Thisshould be a simple, URL-friendly name.
55
+
Each learning path is tied to a specific organization. Before creating content, you must get your organization's unique identifier (UID). Thisis a system-generated ID, not a name you create.
Use only lowercase letters and separate words with hyphens (e.g., `my-company`, `acme-inc`).
57
+
{{< alert type="info" title="What is the UID?" >}}
58
+
The OrganizationUID ensures that your learning content is securely associated with your organization and displayed only to its members. You will use this exact UID to name your core content folders.
59
59
{{< /alert >}}
60
60
61
61
2. **Create the CoreDirectories**
62
62
63
63
Now, inside your `academy-example` project, you should see the following top-level folders.
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.
67
-
2. `static/<your-identifier>/`
67
+
2. `static/<your-organization-uid>/`
68
68
This`static` directory is for all your assets, such as images, diagrams, and so on.
69
-
3. `layouts/shortcodes/<your-identifier>/`
69
+
3. `layouts/shortcodes/<your-organization-uid>/`
70
70
This`layouts` directory is for advanced use. You can place custom **Hugo Shortcodes** here if you need special reusable components in your lessons.
71
71
72
72
3. **Build the ContentHierarchy**
@@ -79,7 +79,7 @@ Use only lowercase letters and separate words with hyphens (e.g., `my-company`,
79
79
content/
80
80
└── learning-paths/
81
81
├── _index.md
82
-
└── <your-identifier>/
82
+
└── <your-organization-uid>/
83
83
└── <your-learning-path>/
84
84
├── _index.md
85
85
└── <your-course-1>/
@@ -97,8 +97,8 @@ Use only lowercase letters and separate words with hyphens (e.g., `my-company`,
97
97
- **The Section (`learning-paths`)**
98
98
This is the top-level category for your content. The `_index.md` file at this level defines the main landing page for all learning paths.
This is the most important folder for ensuring your content is properly scoped. All of your learning paths must reside inside a single folder named with your unique identifier.
This is the most important folder for ensuring your content is properly scoped. All of your learning paths must reside inside a single folder named with your organization uid.
102
102
103
103
- **The Learning Path (`<your-learning-path>`)**
104
104
This folder represents a complete learning path. The `_index.md` file inside it contains the title, description, and other metadata that will be displayed on the learning path's summary card.
@@ -158,7 +158,7 @@ Enhance your course with images and other visual aids. To ensure compatibility w
158
158
**How to Add an Image**
159
159
160
160
1. Place your image file (e.g., `hugo-logo.png`) in your scoped static directory:
2. In your `lesson-1.md` file, embed the image using the `usestatic` shortcode. The `path` is relative to your scoped static folder: 
163
163
164
164
Then the system will automatically convert this into the correct URL when building the site.
0 commit comments