Merge branch 'master' into update-docs-academy-theme-v2

Author: zihanKuang

README.md

@@ -55,17 +55,17 @@ Running the site locally is simple. Provided you have Docker installed, clone th
 
 ### With Golang
 
-If your local development environment has a supported version (v1.21.0+) of Golang installed, next you'll need to install extended hugo version as it has necessary SCSS/SASS support. Find all the hugo packages here: <https://github.com/gohugoio/hugo/releases/tag/v0.120.4>
+If your local development environment has a supported version (v1.21.0+) of Golang installed, next you'll need to install extended Hugo version as it has necessary SCSS/SASS support. Find all the Hugo packages here: <https://github.com/gohugoio/hugo/releases/tag/v0.120.4>
 
 Now to setup and run the site locally run:
 
 `make setup` followed by `make site`
 
 ...and then visit <http://localhost:1313>.
 
-If you pull down new code from GitHub, you will occasionally need run `make setup` again. Otherwise, there's no need to re-run `make setup` each time the site is run, you can just run `make site` to get it going and have it automatically reload as you make and save site edits.
+If you pull down new code from GitHub, you will occasionally need to run `make setup` again. Otherwise, there's no need to re-run `make setup` each time the site is run, you can just run `make site` to get it going and have it automatically reload as you make and save site edits.
 
-## Layer5 Documentation Stucture
+## Layer5 Documentation Structure
 
 ## High-Level Outline & Information Architecture for Layer5 Documentation
 
@@ -81,7 +81,7 @@ If you pull down new code from GitHub, you will occasionally need run `make setu
 ### Getting Started
 
 - **Setting up Layer5 Account:** With a personal account on Layer5 Cloud, you can import or create infrastructural designs, collaborate with others through workspaces and teams, manage your organizations and more.
-- **Creating a Design from Meshery Catalog Templates:** With this guide, you can create amazing cloud native designs for your infrastructure from already avaliable templetes in the meshery catalog.
+- **Creating a Design from Meshery Catalog Templates:** With this guide, you can create amazing cloud native designs for your infrastructure from already available templates in the meshery catalog.
 
 ### Concepts
 
@@ -129,13 +129,13 @@ Low-level ReST API reference for extending Layer5 Cloud.
 - **Starting from a pattern:** A Pattern is an entity that augments the operational behavior of a deployed instance of a Design.
 - **Creating Relationships:** Relationships identify and facilitate genealogy between Components.
 - **Working with Components:** Components represent entities in the Meshery ecosystem, exposing capabilities of the underlying platform.
-- **Starting from scratch:** Emphasiz the underlying system behavior for each action you take.
+- **Starting from scratch:** Emphasize the underlying system behavior for each action you take.
 
 ### Exploring Designer
 
 - **Reviewing Designs:** Learn how to leverage comments in Kanvas’s Designer Mode to enhance collaboration and streamline design reviews.
-- **Whiteboarding:** Whiteboarding and Freestyle Drawing inside kanvas
-- **Export Designs:** How to export your designs for backup , sharing or offline use.
+- **Whiteboarding:** Whiteboarding and Freestyle Drawing inside Kanvas
+- **Export Designs:** How to export your designs for backup, sharing or offline use.
 
 ### Working with Components
 
@@ -195,7 +195,7 @@ To display images in a pop-up modal, use the following syntax: `![alt text](/pat
 
 ### Adding Alert to the site
 
-Use the following Syntax to add a Alert:
+Use the following Syntax to add an Alert:
 `{{< alert type="success" title="Note" >}} Your Note {{< /alert >}}`
 
 - `type="danger"`: Alert used to indicate something related to security.
@@ -204,21 +204,23 @@ Use the following Syntax to add a Alert:
 - `type="note"`: Alert used to indicate a neutral information.
 - `type="success"`: Alert used to indicate a positive information.
 
-By default, if you don't specify a title `title="Your Title"`, the title will be the same as the type name.
+By default, if you don't specify a `title="Your Title"`, the title will be the same as the type name.
 
-**Note-> Using the wrong type will lead to the use of the default alert i.e. success**
+**Note-> Using an invalid alert type will lead to the default alert being used (i.e. success).**
 
 <hr/>
 
 <a name="contributing"></a><a name="community"></a>
-Our projects are community-built and welcome collaboration. 👍 Be sure to see the <a href="https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit">Layer5 Community Welcome Guide</a> for a tour of resources available to you and jump into our <a href="http://slack.layer5.io">Slack</a>!
+Our projects are community-driven and open to collaboration. 👍 Be sure to see the <a href="https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit">Layer5 Community Welcome Guide</a> for a tour of resources available to you. You can also join our <a href="http://slack.layer5.io">Slack</a> to get involved. 
 
 <p style="clear:both;">
 <a href ="https://layer5.io/community/meshmates"><img alt="MeshMates" src=".github/readme/images/layer5-community-sign.png" style="margin-right:10px; margin-bottom:15px;" width="28%" align="left"/></a>
 <h3>Find your MeshMate</h3>
 
-<p>MeshMates are experienced Layer5 community members, who will help you learn your way around, discover live projects and expand your community network.
-Become a <b>Meshtee</b> today!</p>
+<p>
+  MeshMates are experienced Layer5 community members who will help you learn your way around, discover live projects and expand your community network.
+  Become a <b>Meshtee</b> today!
+</p>
 
 Find out more on the <a href="https://layer5.io/community">Layer5 community</a>. <br />
 <br /><br /><br /><br />
@@ -237,7 +239,7 @@ Find out more on the <a href="https://layer5.io/community">Layer5 community</a>.
 <div>
 <a href="https://meshery.io/community"><img alt="Layer5 Community" src=".github/readme/images//community.svg" style="margin-right:8px;padding-top:9px;" width="140px" align="left" /></a>
 <p>
-✔️ <em><strong>Join</strong></em> any or all of the weekly meetings on <a href="https://calendar.google.com/calendar/b/1?cid=bGF5ZXI1LmlvX2VoMmFhOWRwZjFnNDBlbHZvYzc2MmpucGhzQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20">community calendar</a>.<br />
+✔️ <em><strong>Join</strong></em> any or all of the weekly meetings on <a href="https://calendar.google.com/calendar/b/1?cid=bGF5ZXI1LmlvX2VoMmFhOWRwZjFnNDBlbHZvYzc2MmpucGhzQGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20">Community calendar</a>.<br />
 ✔️ <em><strong>Watch</strong></em> community <a href="https://www.youtube.com/playlist?list=PL3A-A6hPO2IMPPqVjuzgqNU5xwnFFn3n0">meeting recordings</a>.<br />
 ✔️ <em><strong>Access</strong></em> the <a href="https://drive.google.com/drive/u/4/folders/0ABH8aabN4WAKUk9PVA">Community Drive</a> by completing a community <a href="https://layer5.io/newcomer">Member Form</a>.<br />
 ✔️ <em><strong>Discuss</strong></em> in the <a href="https://discuss.layer5.io">Community Forum</a>.<br />

charts/index.yaml

@@ -49,7 +49,7 @@ entries:
   layer5-cloud:
   - apiVersion: v2
     appVersion: v0.8.310
-    created: "2025-07-22T09:01:53.679592506Z"
+    created: "2025-07-22T11:35:53.646830128Z"
     dependencies:
     - condition: kratos.enabled
       name: kratos
@@ -60,7 +60,7 @@ entries:
       repository: '@ory'
       version: 0.24.2
     description: Layer5 Cloud is a collection of services that can be deployed on-premises.
-    digest: 54b4fe51ae1bdb0274152957005499258590c422ddf736ebd32229fcdb5a0215
+    digest: 55f64a26c7298e4170137edecf9c3f066f29a7e8c9ef41971a1c72a7a5783ec0
     icon: data:image/svg+xml;base64,PHN2ZyBpZD0iTGF5ZXJfMSIgZGF0YS1uYW1lPSJMYXllciAxIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxNDEuNzMgMTQxLjczIj48dGl0bGU+NS1saWdodC1iZzwvdGl0bGU+PHJlY3QgaWQ9Il9QYXRoXyIgZGF0YS1uYW1lPSImbHQ7UGF0aCZndDsiIHg9Ijc5LjYzIiB5PSIyMy45NyIgd2lkdGg9IjM2LjkzIiBoZWlnaHQ9IjE3Ljc5IiBzdHlsZT0iZmlsbDojMDBiMzlmIi8+PHBhdGggaWQ9Il9QYXRoXzIiIGRhdGEtbmFtZT0iJmx0O1BhdGgmZ3Q7IiBkPSJNMTE5LjkyLDgzLjlWNzYuNTNjMC04LjQ5LTcuMTQtMTUuMzctMTUuOTQtMTUuMzdINDQuMzhWNTYuMzFIMjIuNTZ2MjFIOTguMVY4My45WiIgc3R5bGU9ImZpbGw6IzAwYjM5ZiIvPjxwb2x5Z29uIGlkPSJfUGF0aF8zIiBkYXRhLW5hbWU9IiZsdDtQYXRoJmd0OyIgcG9pbnRzPSI0NC4zOCA1MC41IDQ0LjM4IDQxLjc2IDczLjYgNDEuNzYgNzMuNiAyMy45NyAyMi41NiAyMy45NyAyMi41NiA1MC41IDQ0LjM4IDUwLjUiIHN0eWxlPSJmaWxsOiMwMGQzYTkiLz48cGF0aCBpZD0iX1BhdGhfNCIgZGF0YS1uYW1lPSImbHQ7UGF0aCZndDsiIGQ9Ik05OC4xLDg5LjYyVjEwMEg2OC44OHYxNy43OWgzNmExNC43NywxNC43NywwLDAsMCwxNS0xNC40OVY4OS42MloiIHN0eWxlPSJmaWxsOiMwMGQzYTkiLz48cGF0aCBpZD0iX1BhdGhfNSIgZGF0YS1uYW1lPSImbHQ7UGF0aCZndDsiIGQ9Ik00Mi42Myw5MC41OFYxMDBINjIuODV2MTcuNzloLTI2YTE0Ljc3LDE0Ljc3LDAsMCwxLTE1LTE0LjQ5VjkwLjU4WiIgc3R5bGU9ImZpbGw6IzAwYjM5ZiIvPjwvc3ZnPg==
     name: layer5-cloud
     type: application
@@ -1247,4 +1247,4 @@ entries:
     urls:
     - https://docs.layer5.io/charts/layer5-cloud-v0.8.235.tgz
     version: v0.8.235
-generated: "2025-07-22T09:01:53.674573552Z"
+generated: "2025-07-22T11:35:53.64023914Z"

charts/layer5-cloud-v0.8.310.tgz

@@ -7,7 +7,7 @@ categories: [Academy]
 tags: [Designer]
 ---
 
-This guide provides a step-by-step walkthrough for creating and organizing a new learning path in the [Layer5 Academy](https://cloud.layer5.io/academy/overview). You'll learn how to set up your content repository, structure your courses, add assets, preview your work, and publish it for your organization.
+This guide provides a step-by-step walkthrough for creating and organizing a new learning path in the [Layer5 Academy](https://cloud.layer5.io/academy/content). You'll learn how to set up your content repository, structure your courses, add assets, preview your work, and publish it for your organization.
 
 ### Prerequisites
 
@@ -74,10 +74,8 @@ You can find and copy your Organization UUID from your organization page on [Lay
 
     1. `content/learning-paths/<your-organization-uid>/`
       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.
-    2. `static/<your-organization-uid>/`
-      This `static` directory is for all your assets, such as images, diagrams, and so on. 
-    3. `layouts/shortcodes/<your-organization-uid>/`
-      This `layouts` directory is for advanced use. You can place custom **Hugo Shortcodes** here if you need special reusable components in your Chapters.
+    2. `layouts/shortcodes/<your-organization-uid>/`
+      This `layouts` directory is for advanced use. You can place custom **Hugo Shortcodes** here if you need special reusable components.
 
 3. **Build the Content Hierarchy**
 
@@ -97,6 +95,7 @@ You can find and copy your Organization UUID from your organization page on [Lay
                     ├── _index.md
                     ├── 01-pods.md                 // <-- Chapter 1
                     └── 02-services.md             // <-- Chapter 2
+                    └── arch.png                   // <-- Image
     ```
 
     Each folder represents a level in the hierarchy, and the `_index.md` file within a folder defines the metadata (like title and description) for that level. The final `.md` files are your individual Chapter.
@@ -109,48 +108,48 @@ You can find and copy your Organization UUID from your organization page on [Lay
 
     ```yaml
     ---
-    title: "Mastering Kubernetes for Engineers"
-    description: "Learn how to configure your Kubernetes clusters and manage the lifecycle of your workloads"
-    banner: null  # Optional, URL to banner image
+    title: "Advanced Course"
+    description: "This ADVANCED - Course is where to get the technical knowledge."
+    weight: 5
+    banner: "images/exoscale-icon.svg"
+    id: "754627a3-7993-4b01-a7f0-c66c0212a1a1" 
+    tags: [orchestration]
+    categories: [introductory]
     ---
     ```
 
     > Place this frontmatter in the Markdown file that represents the learning path index page.
 
     **Course Frontmatter (Optional Individual Course Pages)**
 
-      If each course has its own markdown page, you can use this frontmatter:
+    If each course has its own markdown page, you can use this frontmatter:
 
     ```yaml
     ---
-    title: "Kubernetes Basics"
-    description: "Learn the basics of Kubernetes"
-    weight: 1
-    banner: null  # Optional
+    id: "Networks" 
+    title: "Networks"
+    description: "This course clear your Network concept"
+    weight: 2
+    banner: "images/kubernetes-icon.svg"      
+    tags: [network]
+    categories: [introductory]
     ---
     ```
 
     **Summary of Required Fields**
 
-    | Type          | Field         | Required | Notes                       |
-    | ------------- | ------------- | -------- | --------------------------- |
-    | Learning Path | `title`       | ✅        |                             |
-    |               | `description` | ✅        |                             |
-    |               | `weight`      | ✅        | Order in path, lower first  |
-    |               | `banner`      | ❌        | Optional image URI          |
-    | Course        | `title`       | ✅        |                             |
-    |               | `description` | ✅        |                             |
-    |               | `weight`      | ✅        | Order in path   |
-    |               | `banner`      | ❌        | Optional image URI          |
-    |               | `prerequisites`      | ❌        | Optional List of prerequisites for the course |
-    |               | `draft`       | ❌        | Skips build, won't appear|
-    |               | `tags`        | ❌ | Keywords for content |
-    |               | `categories`  | ❌ |  Main content categories |
-
-
-{{< alert type="warning" title="Banner Image Paths" >}}
-When using the `banner` field in your frontmatter, always provide the full, static path to your image. This path must start with your Organization UUID; for example: `/org_id/images/kubernetes-icon.svg`.
-{{< /alert >}}
+    | Applicable To   | Field         | Required | Notes                                                                      |
+    | --------------- | ------------- | :------: | -------------------------------------------------------------------------- |
+    | All             | `title`       |    ✅    | The main display title.                                                    |
+    | All             | `description` |    ✅    | A brief summary of the content.                                            |
+    | All             | `weight`      |    ✅    | Controls the display order (lower numbers appear first).                   |
+    | All             | `banner`      |    ❌    | Path to an image in the `static` folder, e.g., `images/icon.svg`.          |
+    | All             | `tags`        |    ❌    | Keywords for content discovery.                                            |
+    | All             | `categories`  |    ❌    | The main categories for the content.                                       |
+    | All             | `draft`       |    ❌    | If `true`, the page will not be published.                                 |
+    | **Learning Path** | `id`          |    ✅    | **Crucial.** A stable UUID for tracking progress. **Do not change.** [^1]|
+    | **Course** | `id`          |    ❌    | A simple, human-readable string identifier for the course.                 |
+    | **Course** | `prerequisites` |    ❌    | Optional list of prerequisites for the course. |
 
 > 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/).
 
@@ -173,7 +172,7 @@ For all assets, please use the Page Bundling method. It simplifies asset managem
     ```
 
 {{< alert type="warning" title="Legacy Method: Do Not Use" >}}
-The `usestatic` shortcode is **deprecated** and should not be used for new courses.
+The `usestatic` shortcode is **deprecated** and should not be used!
 {{< /alert >}}
 
 **How to Add a Video**
@@ -200,14 +199,20 @@ This will start a local development server, where you can view your learning pat
 ![Preview site](./images/preview-site.png)
 
 {{< alert type="info" title="Local Previews" >}}
-The local preview uses a generic theme to show the structure and content of your learning path. It **will not** display your organization's specific branding, such as custom logos or color schemes. The full, branded experience will only be visible after your content is published to the Layer5 Academy platform. 
+The local preview uses a generic theme to show the structure and content of your learning path. It **will not** display your organization's specific branding, such as custom logos or color schemes.
 
 You can configure your organization's branding in the [Layer5 Cloud Organization Settings](https://cloud.layer5.io/identity/organizations).
 {{< /alert >}}
 
 ## 5. Publishing Your Learning Path
 
-Once you have tested your content locally, you can publish it to the [Layer5 Academy](https://cloud.layer5.io/academy/overview) through our automated workflow. The process involves a one-time setup of secrets and then creating a GitHub Release to publish each new version.
+Once you have tested your content locally, you can publish it to the [Layer5 Academy](https://cloud.layer5.io/academy/content) through our automated workflow. 
+
+To help you visualize how your content goes from a local file to a live learning path, the diagram below illustrates the entire end-to-end publishing workflow. It shows which components you will interact with directly and how the CI/CD pipeline handles the rest automatically.
+
+{{< meshery-design-embed src="..//creating-your-learning-path/images/embedded-design-academy-content-publishing-workflow.js" id="embedded-design-37c37d14-be76-487a-90aa-5ada0c1c115f" size="full" >}}
+
+The process involves a one-time setup of secrets in your repository, followed by creating a GitHub Release to publish each new version of your content.
 
 ### Stage 1: Configure the Publishing Workflow (One-Time Setup)
 
@@ -265,7 +270,7 @@ With the setup complete, you can publish your content anytime by creating a new
 5.  Provide a title and description for your release.
 6.  Click **"Publish release"**.
 
-This action will automatically trigger the workflow, and your content will be deployed to the [Layer5 Academy](https://cloud.layer5.io/identity/overview).
+This action will automatically trigger the workflow, and your content will be deployed to the [Layer5 Academy](https://cloud.layer5.io/academy/content).
 
 - Your content will be available in the [staging environment](https://staging-cloud.layer5.io/) within approximately 10 minutes.
 - Your content will go fully live to the production Academy platform during the next scheduled cloud release.
@@ -320,3 +325,5 @@ go: upgraded github.com/twbs/bootstrap v5.3.6+incompatible => v5.3.7+incompatibl
 5. **How do I structure multiple courses under one learning path?**
 
     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.
+
+[^1]: The auto-generated learning path ID feature will be launched soon.