Skip to content

Commit e217c0f

Browse files
authored
Merge pull request #132 from CodexRaunak/update-v1beta3
Update examples to follow v1beta3 structure and naming scheme
2 parents 635c208 + a3322fb commit e217c0f

6 files changed

Lines changed: 88 additions & 35 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,34 @@ A high-level view of the structure looks like this:
7878
- **Add your lessons** as Markdown (`.md`) files inside the `content` directory of a course.
7979
- **Use frontmatter** at the top of your `_index.md` and lesson files to define titles, descriptions, and weights.
8080
81+
### Add Assessments
82+
83+
Assessment files use the Academy test layout and define their questions in Markdown frontmatter. Use short, stable IDs for questions and options; question IDs must be unique within one assessment, and option IDs must be unique within one question. The Academy theme converts these author-facing IDs into deterministic UUIDs in the generated JSON consumed by Layer5 Cloud.
84+
85+
```yaml
86+
---
87+
title: "Assessment Example"
88+
id: "assessment-example"
89+
type: "test"
90+
layout: "test"
91+
passPercentage: 70
92+
maxAttempts: 3
93+
timeLimit: 30
94+
numberOfQuestions: 1
95+
questions:
96+
- id: "q1"
97+
text: "Academy content is authored in Markdown."
98+
type: "true-false"
99+
marks: 1
100+
options:
101+
- id: "true"
102+
text: "True"
103+
isCorrect: true
104+
- id: "false"
105+
text: "False"
106+
---
107+
```
108+
81109
### 5. Add Assets (Images & Videos)
82110
83111
Enhance your course with images and other visual aids. To ensure compatibility with the multi-tenant Academy platform, **do not use standard Markdown image links**. Instead, use the `usestatic` shortcode, which generates the correct, tenant-aware path for your assets.
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
22
title: "Module Quiz"
3-
pass_percentage: 70
3+
id: "course-1-module-quiz"
4+
layout: "test"
5+
passPercentage: 70
6+
maxAttempts: 3
7+
timeLimit: 30
8+
numberOfQuestions: 3
49
questions:
510
- id: "q1"
611
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
@@ -11,7 +16,7 @@ questions:
1116
text: "Meshery"
1217
- id: "b"
1318
text: "Kanvas"
14-
is_correct: true
19+
isCorrect: true
1520
- id: "c"
1621
text: "Istio"
1722
- id: "d"
@@ -23,19 +28,19 @@ questions:
2328
options:
2429
- id: "a"
2530
text: "MeshSync"
26-
is_correct: true
31+
isCorrect: true
2732
- id: "b"
2833
text: "Broker"
29-
is_correct: true
34+
isCorrect: true
3035
- id: "c"
3136
text: "Operator"
32-
is_correct: true
37+
isCorrect: true
3338
- id: "d"
3439
text: "Docker Engine"
3540
- id: "q3"
3641
text: "Which tool manages Kubernetes namespace labeling?"
3742
type: "short-answer"
3843
marks: 2
39-
correct_answer: "kubectl"
44+
correctAnswer: "kubectl"
4045
type: "test"
41-
---
46+
---
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
22
title: "Course Test"
3-
pass_percentage: 70
3+
id: "course-1-test"
4+
layout: "test"
5+
passPercentage: 70
6+
maxAttempts: 3
7+
timeLimit: 30
8+
numberOfQuestions: 3
49
questions:
510
- id: "q1"
611
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
@@ -11,7 +16,7 @@ questions:
1116
text: "Meshery"
1217
- id: "b"
1318
text: "Kanvas"
14-
is_correct: true
19+
isCorrect: true
1520
- id: "c"
1621
text: "Istio"
1722
- id: "d"
@@ -23,19 +28,19 @@ questions:
2328
options:
2429
- id: "a"
2530
text: "MeshSync"
26-
is_correct: true
31+
isCorrect: true
2732
- id: "b"
2833
text: "Broker"
29-
is_correct: true
34+
isCorrect: true
3035
- id: "c"
3136
text: "Operator"
32-
is_correct: true
37+
isCorrect: true
3338
- id: "d"
3439
text: "Docker Engine"
3540
- id: "q3"
3641
text: "Which tool manages Kubernetes namespace labeling?"
3742
type: "short-answer"
3843
marks: 2
39-
correct_answer: "kubectl"
44+
correctAnswer: "kubectl"
4045
type: "test"
41-
---
46+
---
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
22
title: "Module Quiz"
3-
pass_percentage: 70
3+
id: "course-2-module-quiz"
4+
layout: "test"
5+
passPercentage: 70
6+
maxAttempts: 3
7+
timeLimit: 30
8+
numberOfQuestions: 3
49
questions:
510
- id: "q1"
611
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
@@ -11,7 +16,7 @@ questions:
1116
text: "Meshery"
1217
- id: "b"
1318
text: "Kanvas"
14-
is_correct: true
19+
isCorrect: true
1520
- id: "c"
1621
text: "Istio"
1722
- id: "d"
@@ -23,19 +28,19 @@ questions:
2328
options:
2429
- id: "a"
2530
text: "MeshSync"
26-
is_correct: true
31+
isCorrect: true
2732
- id: "b"
2833
text: "Broker"
29-
is_correct: true
34+
isCorrect: true
3035
- id: "c"
3136
text: "Operator"
32-
is_correct: true
37+
isCorrect: true
3338
- id: "d"
3439
text: "Docker Engine"
3540
- id: "q3"
3641
text: "Which tool manages Kubernetes namespace labeling?"
3742
type: "short-answer"
3843
marks: 2
39-
correct_answer: "kubectl"
44+
correctAnswer: "kubectl"
4045
type: "test"
41-
---
46+
---
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
22
title: "Course Test"
3-
pass_percentage: 70
3+
id: "course-2-test"
4+
layout: "test"
5+
passPercentage: 70
6+
maxAttempts: 3
7+
timeLimit: 30
8+
numberOfQuestions: 3
49
questions:
510
- id: "q1"
611
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
@@ -11,7 +16,7 @@ questions:
1116
text: "Meshery"
1217
- id: "b"
1318
text: "Kanvas"
14-
is_correct: true
19+
isCorrect: true
1520
- id: "c"
1621
text: "Istio"
1722
- id: "d"
@@ -23,19 +28,19 @@ questions:
2328
options:
2429
- id: "a"
2530
text: "MeshSync"
26-
is_correct: true
31+
isCorrect: true
2732
- id: "b"
2833
text: "Broker"
29-
is_correct: true
34+
isCorrect: true
3035
- id: "c"
3136
text: "Operator"
32-
is_correct: true
37+
isCorrect: true
3338
- id: "d"
3439
text: "Docker Engine"
3540
- id: "q3"
3641
text: "Which tool manages Kubernetes namespace labeling?"
3742
type: "short-answer"
3843
marks: 2
39-
correct_answer: "kubectl"
44+
correctAnswer: "kubectl"
4045
type: "test"
41-
---
46+
---
Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
---
22
title: "Learning Path Exam"
3-
pass_percentage: 70
3+
id: "learning-path-exam"
4+
layout: "test"
5+
passPercentage: 70
6+
maxAttempts: 3
7+
timeLimit: 30
8+
numberOfQuestions: 3
49
questions:
510
- id: "q1"
611
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
@@ -11,7 +16,7 @@ questions:
1116
text: "Meshery"
1217
- id: "b"
1318
text: "Kanvas"
14-
is_correct: true
19+
isCorrect: true
1520
- id: "c"
1621
text: "Istio"
1722
- id: "d"
@@ -23,19 +28,19 @@ questions:
2328
options:
2429
- id: "a"
2530
text: "MeshSync"
26-
is_correct: true
31+
isCorrect: true
2732
- id: "b"
2833
text: "Broker"
29-
is_correct: true
34+
isCorrect: true
3035
- id: "c"
3136
text: "Operator"
32-
is_correct: true
37+
isCorrect: true
3338
- id: "d"
3439
text: "Docker Engine"
3540
- id: "q3"
3641
text: "Which tool manages Kubernetes namespace labeling?"
3742
type: "short-answer"
3843
marks: 2
39-
correct_answer: "kubectl"
44+
correctAnswer: "kubectl"
4045
type: "test"
41-
---
46+
---

0 commit comments

Comments
 (0)