Skip to content

Commit 952faf5

Browse files
committed
2 main updates
Signed-off-by: Wyllie Fang <[email protected]>
1 parent c2148ce commit 952faf5

File tree

2 files changed

+55
-54
lines changed
  • content/en/cloud/academy/creating-content
    • creating-your-learning-path
    • integrating-assessments-in-the-academy

2 files changed

+55
-54
lines changed

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

Lines changed: 44 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -365,39 +365,49 @@ make clean
365365

366366
## Frequently Asked Questions
367367

368-
1. **Why is my workflow failing with a `401 Unauthorized` or `user must be logged in` error?**
369-
370-
This error indicates an issue with your **`ACADEMY_TOKEN`**. Please ensure you have correctly copied **only the token string** and not the entire JSON object from the downloaded file.
371-
372-
2. **Why is my workflow failing with a URL containing a double slash (`//`)?**
373-
374-
A double slash in the URL (e.g., `.../api/academy//update/...`) means your **`ACADEMY_ORG_ID`** was not found. This typically happens when the secret name in your repository does not **exactly match** the name expected by the workflow file (e.g., `ORG_ID`).
375-
376-
3. **How do I handle updates or corrections after my content is live?**
377-
378-
All content updates are managed through your Git repository. Simply commit and push your changes, then **create a new GitHub Release** with a new version number (e.g., `v1.0.2`). This automatically triggers the publishing workflow and updates your content on the Academy platform.
379-
380-
4. **What happens if my new content has an error?**
381-
382-
The publishing process is designed to be safe. If your new content causes a build error, the workflow will fail, and the previously working version of the Academy will remain unchanged. Your broken update will not be published.
383-
384-
5. **How do I structure multiple courses under one learning path?**
385-
386-
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.
387-
388-
6. **Why does my local build fail when adding large videos?**
389-
390-
Hugo's default memory limit is 512MB. For videos >50MB:
391-
```bash
392-
hugo server --memlimit 2GB
393-
```
394-
395-
7. **How to securely host private training videos?**
396-
397-
Use AWS S3 with signed URLs:
398-
```html
399-
<video src="{{</* s3_signed_url path="training/private.mp4" */>}}">
400-
```
401-
368+
<details>
369+
<summary>1. Why is my workflow failing with a <code>401 Unauthorized</code> or <code>User must be logged in</code> error?</summary>
370+
371+
This error indicates an issue with your <code>ACADEMY_TOKEN</code>. Please ensure you have correctly copied only the token string and not the entire JSON object from the downloaded file.
372+
</details>
373+
374+
<details>
375+
<summary>2. Why is my workflow failing with a URL containing a double slash </code>( // )</code>?</summary>
376+
377+
A double slash in the URL (e.g., <code>.../api/academy//update/...</code>) means your <strong>ACADEMY_ORG_ID</strong> was not found. This typically happens when the secret name in your repository does not <strong>exactly match</strong> the name expected by the workflow file (e.g., <code>ORG_ID</code>).
378+
</details>
379+
380+
<details>
381+
<summary>3. How do I handle updates or corrections after my content is live?</summary>
382+
383+
All content updates are managed through your Git repository. Simply commit and push your changes, then <strong>create a new GitHub Release</strong> with a new version number (e.g., <code>v1.0.2</code>). This automatically triggers the publishing workflow and updates your content on the Academy platform.
384+
</details>
385+
386+
<details>
387+
<summary>4. What happens if my new content has an error?</summary>
388+
389+
The publishing process is designed to be safe. If your new content causes a build error, the workflow will fail, and the previously working version of the Academy will remain unchanged. Your broken update will not be published.
390+
</details>
391+
392+
<details>
393+
<summary>5. How do I structure multiple courses under one learning path?</summary>
394+
395+
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 <code>content</code> directory directly maps to the learning path structure presented to users.
396+
</details>
397+
398+
<details>
399+
<summary>6. Why does my local build fail when adding large videos?</summary>
400+
401+
The ideal size should be less than 10MB for our service performance and sustainability, and server resource management. If your asset size is larger than 10MB, we recommend using external hosting as listed.
402+
</details>
403+
404+
<details>
405+
<summary>7. How to securely host private training videos?</summary>
406+
407+
Use AWS S3 with signed URLs:
408+
```html
409+
<video src="{{</* s3_signed_url path="training/private.mp4" */>}}">
410+
```
411+
</details>
402412

403413
[^1]: The auto-generated learning path ID feature will be launched soon.

content/en/cloud/academy/creating-content/integrating-assessments-in-the-academy/index.md

Lines changed: 11 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -305,42 +305,33 @@ After an assessment is submitted and scored, a detailed result record is permane
305305

306306
## Frequently Asked Questions
307307

308-
<details style="margin-bottom: 1em;">
308+
<details>
309309
<summary>1. Is the <code>id</code> field required in the file's front matter?</summary>
310310

311-
<div style="padding-left: 1.5em;">
312-
<p><strong>Answer:</strong> No, the <code>id</code> field is <strong>optional</strong>. If omitted, the system auto-generates a unique ID based on the file path (e.g., <code>7a4af2222daae1111acfac539f657724</code>). However, we strongly recommend specifying a human-readable, globally unique ID (e.g., <code>test-intro-meshery</code>, <code>quiz-containers</code>, <code>test-intro-kubernetes</code>) for better traceability and debugging.</p>
313-
</div>
311+
No, the <code>id</code> field is <strong>optional</strong>. If omitted, the system auto-generates a unique ID based on the file path (e.g., <code>7a4af2222daae1111acfac539f657724</code>). However, we strongly recommend specifying a human-readable, globally unique ID (e.g., <code>test-intro-meshery</code>, <code>quiz-containers</code>, <code>test-intro-kubernetes</code>) for better traceability and debugging.
314312
</details>
315313

316-
<details style="margin-bottom: 1em;">
314+
<details>
317315
<summary>2. Why is an assessment required for every Course and Learning Path?</summary>
318316

319-
<div style="padding-left: 1.5em;">
320-
<p><strong>Answer:</strong> The system determines the completion of a Course or Learning Path based on whether the learner passes its designated assessment (e.g., <code>test.md</code>, <code>exam.md</code>). Without this, the system has no trigger to mark the level as completed or to award achievements such as badges. Module-level quizzes are intended for practice and do not trigger parent-level completion.</p>
321-
</div>
317+
The system determines the completion of a Course or Learning Path based on whether the learner passes its designated assessment (e.g., <code>test.md</code>, <code>exam.md</code>). Without this, the system has no trigger to mark the level as completed or to award achievements such as badges. Module-level quizzes are intended for practice and do not trigger parent-level completion.
318+
322319
</details>
323320

324-
<details style="margin-bottom: 1em;">
321+
<details>
325322
<summary>3. Can I fully test the assessment (including scoring) locally?</summary>
326323

327-
<div style="padding-left: 1.5em;">
328-
<p><strong>Answer:</strong> You can preview the test layout locally, but scoring and evaluation are handled by the backend server. This means submission, grading, and result processing are not available in local previews. You must publish the content to test full functionality.</p>
329-
</div>
324+
You can preview the test layout locally, but scoring and evaluation are handled by the backend server. This means submission, grading, and result processing are not available in local previews. You must publish the content to test full functionality.
330325
</details>
331326

332-
<details style="margin-bottom: 1em;">
327+
<details>
333328
<summary>4. How are multiple-answer questions scored? Is partial credit given?</summary>
334329

335-
<div style="padding-left: 1.5em;">
336-
<p><strong>Answer:</strong> No partial credit is awarded. To receive points, the learner must select all correct options and avoid all incorrect ones. Selecting a wrong option or missing a correct one results in zero marks for that question.</p>
337-
</div>
330+
No partial credit is awarded. To receive points, the learner must select all correct options and avoid all incorrect ones. Selecting a wrong option or missing a correct one results in zero marks for that question.
338331
</details>
339332

340-
<details style="margin-bottom: 1em;">
333+
<details>
341334
<summary>5. Can a learner retake an assessment even after scoring 100%?</summary>
342335

343-
<div style="padding-left: 1.5em;">
344-
<p><strong>Answer:</strong> Yes. Even if a learner scores 100%, they are allowed to retake the assessment. The system does not restrict retakes based on previous scores. This design supports repeated practice, randomized question pools, and flexible testing workflows—without enforcing score-based access rules.</p>
345-
</div>
336+
Yes. Even if a learner scores 100%, they are allowed to retake the assessment. The system does not restrict retakes based on previous scores. This design supports repeated practice, randomized question pools, and flexible testing workflows—without enforcing score-based access rules.
346337
</details>

0 commit comments

Comments
 (0)