Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,34 @@ A high-level view of the structure looks like this:
- **Add your lessons** as Markdown (`.md`) files inside the `content` directory of a course.
- **Use frontmatter** at the top of your `_index.md` and lesson files to define titles, descriptions, and weights.

### Add Assessments

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.

```yaml
---
title: "Assessment Example"
id: "assessment-example"
type: "test"
layout: "test"
passPercentage: 70
maxAttempts: 3
timeLimit: 30
numberOfQuestions: 1
questions:
- id: "q1"
text: "Academy content is authored in Markdown."
type: "true-false"
marks: 1
options:
- id: "true"
text: "True"
isCorrect: true
- id: "false"
text: "False"
---
```

### 5. Add Assets (Images & Videos)

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
---
title: "Module Quiz"
pass_percentage: 70
id: "course-1-module-quiz"
layout: "test"
passPercentage: 70
Comment thread
CodexRaunak marked this conversation as resolved.
maxAttempts: 3
timeLimit: 30
numberOfQuestions: 3
questions:
- id: "q1"
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
Expand All @@ -11,7 +16,7 @@ questions:
text: "Meshery"
- id: "b"
text: "Kanvas"
is_correct: true
isCorrect: true
- id: "c"
text: "Istio"
- id: "d"
Expand All @@ -23,19 +28,19 @@ questions:
options:
- id: "a"
text: "MeshSync"
is_correct: true
isCorrect: true
- id: "b"
text: "Broker"
is_correct: true
isCorrect: true
- id: "c"
text: "Operator"
is_correct: true
isCorrect: true
- id: "d"
text: "Docker Engine"
- id: "q3"
text: "Which tool manages Kubernetes namespace labeling?"
type: "short-answer"
marks: 2
correct_answer: "kubectl"
correctAnswer: "kubectl"
type: "test"
---
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
---
title: "Course Test"
pass_percentage: 70
id: "course-1-test"
layout: "test"
passPercentage: 70
Comment thread
CodexRaunak marked this conversation as resolved.
maxAttempts: 3
timeLimit: 30
numberOfQuestions: 3
questions:
- id: "q1"
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
Expand All @@ -11,7 +16,7 @@ questions:
text: "Meshery"
- id: "b"
text: "Kanvas"
is_correct: true
isCorrect: true
- id: "c"
text: "Istio"
- id: "d"
Expand All @@ -23,19 +28,19 @@ questions:
options:
- id: "a"
text: "MeshSync"
is_correct: true
isCorrect: true
- id: "b"
text: "Broker"
is_correct: true
isCorrect: true
- id: "c"
text: "Operator"
is_correct: true
isCorrect: true
- id: "d"
text: "Docker Engine"
- id: "q3"
text: "Which tool manages Kubernetes namespace labeling?"
type: "short-answer"
marks: 2
correct_answer: "kubectl"
correctAnswer: "kubectl"
type: "test"
---
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
---
title: "Module Quiz"
pass_percentage: 70
id: "course-2-module-quiz"
layout: "test"
passPercentage: 70
Comment thread
CodexRaunak marked this conversation as resolved.
maxAttempts: 3
timeLimit: 30
numberOfQuestions: 3
questions:
- id: "q1"
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
Expand All @@ -11,7 +16,7 @@ questions:
text: "Meshery"
- id: "b"
text: "Kanvas"
is_correct: true
isCorrect: true
- id: "c"
text: "Istio"
- id: "d"
Expand All @@ -23,19 +28,19 @@ questions:
options:
- id: "a"
text: "MeshSync"
is_correct: true
isCorrect: true
- id: "b"
text: "Broker"
is_correct: true
isCorrect: true
- id: "c"
text: "Operator"
is_correct: true
isCorrect: true
- id: "d"
text: "Docker Engine"
- id: "q3"
text: "Which tool manages Kubernetes namespace labeling?"
type: "short-answer"
marks: 2
correct_answer: "kubectl"
correctAnswer: "kubectl"
type: "test"
---
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
---
title: "Course Test"
pass_percentage: 70
id: "course-2-test"
layout: "test"
passPercentage: 70
Comment thread
CodexRaunak marked this conversation as resolved.
maxAttempts: 3
timeLimit: 30
numberOfQuestions: 3
questions:
- id: "q1"
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
Expand All @@ -11,7 +16,7 @@ questions:
text: "Meshery"
- id: "b"
text: "Kanvas"
is_correct: true
isCorrect: true
- id: "c"
text: "Istio"
- id: "d"
Expand All @@ -23,19 +28,19 @@ questions:
options:
- id: "a"
text: "MeshSync"
is_correct: true
isCorrect: true
- id: "b"
text: "Broker"
is_correct: true
isCorrect: true
- id: "c"
text: "Operator"
is_correct: true
isCorrect: true
- id: "d"
text: "Docker Engine"
- id: "q3"
text: "Which tool manages Kubernetes namespace labeling?"
type: "short-answer"
marks: 2
correct_answer: "kubectl"
correctAnswer: "kubectl"
type: "test"
---
---
19 changes: 12 additions & 7 deletions content/learning-paths/your-org-uuid/example-learning-path/exam.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
---
title: "Learning Path Exam"
pass_percentage: 70
id: "learning-path-exam"
layout: "test"
passPercentage: 70
Comment thread
CodexRaunak marked this conversation as resolved.
maxAttempts: 3
timeLimit: 30
numberOfQuestions: 3
questions:
- id: "q1"
text: "Which Layer5 project is used for visual design in Kubernetes and cloud native infrastructure?"
Expand All @@ -11,7 +16,7 @@ questions:
text: "Meshery"
- id: "b"
text: "Kanvas"
is_correct: true
isCorrect: true
- id: "c"
text: "Istio"
- id: "d"
Expand All @@ -23,19 +28,19 @@ questions:
options:
- id: "a"
text: "MeshSync"
is_correct: true
isCorrect: true
- id: "b"
text: "Broker"
is_correct: true
isCorrect: true
- id: "c"
text: "Operator"
is_correct: true
isCorrect: true
- id: "d"
text: "Docker Engine"
- id: "q3"
text: "Which tool manages Kubernetes namespace labeling?"
type: "short-answer"
marks: 2
correct_answer: "kubectl"
correctAnswer: "kubectl"
type: "test"
---
---
Loading