Skip to content

Commit 93e9dcd

Browse files
authored
Merge pull request #700 from zihanKuang/update
Docs: Clarify banner frontmatter usage and add summary table
2 parents 5950d76 + cdb021b commit 93e9dcd

File tree

1 file changed

+14
-3
lines changed
  • content/en/cloud/academy/creating-your-learning-path

1 file changed

+14
-3
lines changed

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

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,21 @@ You can find and copy your Organization UUID from your organization page on [Lay
136136
| ------------- | ------------- | -------- | --------------------------- |
137137
| Learning Path | `title` | ✅ | |
138138
| | `description` | ✅ | |
139-
| | `weight` | ✅ | Defines order in the path, Lower numbers appear first |
139+
| | `weight` | ✅ | Order in path, lower first |
140140
| | `banner` | ❌ | Optional image URI |
141141
| Course | `title` | ✅ | |
142142
| | `description` | ✅ | |
143-
| | `weight` | ✅ | Defines order in the path |
143+
| | `weight` | ✅ | Order in path |
144144
| | `banner` | ❌ | Optional image URI |
145145
| | `prerequisites` | ❌ | Optional List of prerequisites for the course |
146+
| | `draft` | ❌ | Skips build, won't appear|
147+
| | `tags` | ❌ | Keywords for content |
148+
| | `categories` | ❌ | Main content categories |
149+
150+
151+
{{< alert type="warning" title="Banner Image Paths" >}}
152+
When using the `banner` field in your frontmatter, you cannot use the `usestatic` shortcode. You must provide the full, static path to the image, starting with your Organization UUID.
153+
{{< /alert >}}
146154

147155
> 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/).
148156

@@ -264,6 +272,9 @@ With the setup complete, you can publish your content anytime by creating a new
264272

265273
This action will automatically trigger the workflow, and your content will be deployed to the [Layer5 Academy](https://cloud.layer5.io/identity/overview).
266274

275+
- Your content will be available in the [staging environment](https://staging-cloud.layer5.io/) within approximately 10 minutes.
276+
- Your content will go fully live to the production Academy platform during the next scheduled cloud release.
277+
267278
> **For Urgent Updates:** If you have a time-sensitive publishing request or encounter any issues with the automated process, please [contact the Layer5 team](https://layer5.io/company/contact) for expedited assistance.
268279

269280
![Release Example](./images/release-publish.gif)
@@ -288,4 +299,4 @@ This action will automatically trigger the workflow, and your content will be de
288299

289300
5. **How do I structure multiple courses under one learning path?**
290301

291-
The structure is defined by your folder hierarchy. A learning path is a directory, and each course is a sub-directory within that path. This folder structure in your `content` directory directly maps to the learning path structure presented to users.
302+
The structure is defined by your folder hierarchy. A learning path is a directory, and each course is a sub-directory within that path. This folder structure in your `content` directory directly maps to the learning path structure presented to users.

0 commit comments

Comments
 (0)