Skip to content

Commit b0b439e

Browse files
committed
change to org-uuid
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
1 parent 4a683bc commit b0b439e

File tree

2 files changed

+11
-238
lines changed
  • content/en/cloud/academy

2 files changed

+11
-238
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,23 +50,23 @@ This step is essential. It updates your repository's "identity card" (`go.mod`)
5050

5151
The Academy uses a specific directory layout to keep each organization's content separate and secure.
5252
53-
1. **Define Your Unique Identifier**
53+
1. **Get Your Organization ID**
5454
55-
First, you'll need a unique identifier for your organization. This should 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). This is a system-generated ID, not a name you create.
5656

57-
{{< alert type="warning" title="Naming Standard" >}}
58-
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 Organization UID 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.
5959
{{< /alert >}}
6060

6161
2. **Create the Core Directories**
6262

6363
Now, inside your `academy-example` project, you should see the following top-level folders.
6464

65-
1. `content/learning-paths/<your-identifier>/`
65+
1. `content/learning-paths/<your-organization-uid>/`
6666
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>/`
6868
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>/`
7070
This `layouts` directory is for advanced use. You can place custom **Hugo Shortcodes** here if you need special reusable components in your lessons.
7171

7272
3. **Build the Content Hierarchy**
@@ -79,7 +79,7 @@ Use only lowercase letters and separate words with hyphens (e.g., `my-company`,
7979
content/
8080
└── learning-paths/
8181
├── _index.md
82-
└── <your-identifier>/
82+
└── <your-organization-uid>/
8383
└── <your-learning-path>/
8484
├── _index.md
8585
└── <your-course-1>/
@@ -97,8 +97,8 @@ Use only lowercase letters and separate words with hyphens (e.g., `my-company`,
9797
- **The Section (`learning-paths`)**
9898
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.
9999
100-
- **Your Organization Folder (`<your-identifier>`)**
101-
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.
100+
- **Your Organization Folder (`<your-organization-uid>`)**
101+
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.
102102
103103
- **The Learning Path (`<your-learning-path>`)**
104104
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
158158
**How to Add an Image**
159159
160160
1. Place your image file (e.g., `hugo-logo.png`) in your scoped static directory:
161-
`static/<your-identifier>/images/hugo-logo.png`
161+
`static/<your-organization-uid>/images/hugo-logo.png`
162162
2. In your `lesson-1.md` file, embed the image using the `usestatic` shortcode. The `path` is relative to your scoped static folder: ![The Hugo Logo]({{</* usestatic path="images/hugo-logo.png" */>}})
163163
164164
Then the system will automatically convert this into the correct URL when building the site.

content/en/cloud/academy/frontmatter/_index

Lines changed: 0 additions & 227 deletions
This file was deleted.

0 commit comments

Comments
 (0)