Skip to content

Commit 4bb23f3

Browse files
committed
Update docs for adherence to Academy's v1beta3 structure and naming scheme
Signed-off-by: Raunak Madan <madanraunak24@gmail.com>
1 parent b55f680 commit 4bb23f3

2 files changed

Lines changed: 21 additions & 20 deletions

File tree

  • content/en/cloud/academy/creating-content

content/en/cloud/academy/creating-content/building-certifications/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,12 @@ For detailed instructions on how to write an exam file, define various question
135135

136136
A **test** can include more questions than those presented to users in a single attempt, effectively turning it into a **test bank** — collection of all possible questions available for that test. When users retry the test, a new set of questions is drawn from the test bank for each attempt.
137137

138-
This behavior is controlled by the `number_of_questions` property in the front matter.
138+
This behavior is controlled by the `numberOfQuestions` property in the front matter.
139139

140-
* If `number_of_questions` is **not defined**, all questions in the test are used in every attempt.
140+
* If `numberOfQuestions` is **not defined**, all questions in the test are used in every attempt.
141141
* If it **is defined**, the test is automatically divided into multiple sets, each containing the specified number of questions.
142142

143-
To ensure even division, the **total number of questions** must be a **multiple** of `number_of_questions`.
143+
To ensure even division, the **total number of questions** must be a **multiple** of `numberOfQuestions`.
144144

145145
By default, the **number of retries** is set to the number of generated sets. However, you can increase it, in which case the question sets will **cycle** through repeatedly across attempts.
146146

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

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Each assessment file must contain the following YAML frontmatter:
109109
---
110110
title: "Assessment Example"
111111
id: "assessment-id"
112-
pass_percentage: 70
112+
passPercentage: 70
113113
type: "test"
114114
layout: "test"
115115
is_optional: true
@@ -124,7 +124,7 @@ questions:
124124
text: "Option A text"
125125
- id: "b"
126126
text: "Option B text"
127-
is_correct: true
127+
isCorrect: true
128128
---
129129
```
130130

@@ -136,18 +136,19 @@ questions:
136136
| :--- | :--- | :--- | :--- |
137137
| **Assessment** | `title` | - | A short, descriptive name for the assessment (e.g., "Final Exam" or "Module 3 Quiz"). |
138138
| | `id` | - | Unique identifier for the assessment. If omitted, a UUID will be auto-generated. |
139-
| | `pass_percentage` || Minimum score required to pass the assessment (e.g., `70`). |
139+
| | `passPercentage` || Minimum score required to pass the assessment (e.g., `70`). |
140140
| | `type` || Metadata type for the assessment. The value must be `test`. |
141141
| | `layout` | - | Metadata type for the assessment. The value must be `test`. |
142142
| | `is_optional` | - | A boolean value. If `true`, the assessment can be skipped without affecting completion. |
143143
| | `final` | - | A boolean flag. Set to `true` if this assessment determines the completion for its parent course or path. |
144144
| | `questions` || An array containing one or more question objects. |
145-
| **Question Object** | `id` || Unique identifier for the question within the assessment (e.g., `q1`, `q2`). |
145+
| **Question Object** | `id` || Stable source key for the question. Must be unique within the assessment (e.g., `q1`, `q2`). |
146146
| | `text` || The text of the question prompt. |
147147
| | `type` || The type of question. Accepted values are `single-answer`, `multiple-answers`, `short-answer`, or `true-false`. |
148148
| | `marks` || The number of points awarded for a correct answer. |
149149
| | `instructions` | - | Custom instruction for each question |
150-
| | `options` | - | An array of answer options. |
150+
| | `correctAnswer` | - | Expected answer for `short-answer` questions. |
151+
| | `options` | - | An array of answer options. Each option `id` must be unique within its question. |
151152

152153
{{< alert type="warning" title="Quick heads up" >}}
153154
Remember: `type: "test"` are fixed values that cannot be modified. The system needs these exact words to work properly.
@@ -174,7 +175,7 @@ Layer5 Academy supports four question formats:
174175
options:
175176
- id: "a"
176177
text: "Option A"
177-
is_correct: true # correct option
178+
isCorrect: true # correct option
178179
- id: "b"
179180
text: "Option B"
180181
---
@@ -193,7 +194,7 @@ Layer5 Academy supports four question formats:
193194
options:
194195
- id: "true"
195196
text: "True"
196-
is_correct: true # correct option
197+
isCorrect: true # correct option
197198
- id: "false"
198199
text: "False"
199200
---
@@ -217,12 +218,12 @@ Layer5 Academy supports four question formats:
217218
options:
218219
- id: "a"
219220
text: "Option A"
220-
is_correct: true # correct option
221+
isCorrect: true # correct option
221222
- id: "b"
222223
text: "Option B"
223224
- id: "c"
224225
text: "Option C"
225-
is_correct: true # correct option
226+
isCorrect: true # correct option
226227
---
227228
</code></pre>
228229
</details>
@@ -244,13 +245,13 @@ Layer5 Academy supports four question formats:
244245
type: "short-answer" # choose the type
245246
marks: 2
246247
instructions: "Just type the command"
247-
correct_answer: "default" # expected answer
248+
correctAnswer: "default" # expected answer
248249

249250
- id: "question5"
250251
text: "Which kubectl command lists all pods?"
251252
type: "short-answer" # choose the type
252253
marks: 2
253-
correct_answer: "kubectl get pods" # expected answer
254+
correctAnswer: "kubectl get pods" # expected answer
254255
---
255256
</code></pre>
256257
</details>
@@ -317,7 +318,7 @@ Instructions can be override in frontmatter by defining a custom intruction for
317318
type: "short-answer"
318319
marks: 2
319320
instructions: "Just type the command" #custom instruction
320-
correct_answer: "default"
321+
correctAnswer: "default"
321322

322323
questions: # will display the default instructions for question type
323324
- id: "question3"
@@ -327,31 +328,31 @@ Instructions can be override in frontmatter by defining a custom intruction for
327328
options:
328329
- id: "a"
329330
text: "Option A"
330-
is_correct: true # correct option
331+
isCorrect: true # correct option
331332
- id: "b"
332333
text: "Option B"
333334
- id: "c"
334335
text: "Option C"
335-
is_correct: true # correct option
336+
isCorrect: true # correct option
336337
---
337338
</code></pre>
338339
</details>
339340

340341

341342
## Scoring
342343

343-
The scoring process is handled automatically by the backend system. As a content creator, your main responsibility is to define the `marks` for each question and the overall `pass_percentage` for the assessment. Here is how the system processes the scores:
344+
The scoring process is handled automatically by the backend system. As a content creator, your main responsibility is to define the `marks` for each question and the overall `passPercentage` for the assessment. Here is how the system processes the scores:
344345

345346
### How Scores Are Calculated
346347

347348
1. **Total Possible Marks**: The total score for a assessment is automatically calculated by summing the `marks` value of every question within that assessment. You do not need to define this total manually.
348349
2. **Learner's Score**: A learner's final score is the sum of the `marks` from all the questions they answered correctly.
349-
3. **Pass/Fail Status**: The system calculates the final percentage using the formula `(Learner's Score / Total Possible Marks) * 100`. If this percentage is greater than or equal to the `pass_percentage` you set, the assessment is marked as "Passed".
350+
3. **Pass/Fail Status**: The system calculates the final percentage using the formula `(Learner's Score / Total Possible Marks) * 100`. If this percentage is greater than or equal to the `passPercentage` you set, the assessment is marked as "Passed".
350351

351352
### Scoring Rules for Question Types
352353

353354
- **Multiple-Choice Questions**: For questions with a single correct answer, the logic is straightforward. For **multiple-answer questions**, the scoring is strict: the learner must select **all** correct options and **none** of the incorrect options to earn the marks. There is no partial credit.
354-
- **Short Answer Questions**: The learner's input is compared against the `correct_answer` field. The comparison is **case-insensitive**, and leading/trailing whitespace is ignored to avoid penalizing minor typing variations.
355+
- **Short Answer Questions**: The learner's input is compared against the `correctAnswer` field. The comparison is **case-insensitive**, and leading/trailing whitespace is ignored to avoid penalizing minor typing variations.
355356

356357
### The Result of Scoring
357358

0 commit comments

Comments
 (0)