Skip to content

Commit 9917ee1

Browse files
committed
assesment instruction update
Signed-off-by: Namanv0509 <[email protected]>
1 parent 994b661 commit 9917ee1

File tree

1 file changed

+47
-0
lines changed
  • content/en/cloud/academy/creating-content/integrating-assessments-in-the-academy

1 file changed

+47
-0
lines changed

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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ questions:
146146
| | `text` || The text of the question prompt. |
147147
| | `type` || The type of question. Accepted values are `single-answer`, `multiple-answers` or `short_answer`. |
148148
| | `marks` || The number of points awarded for a correct answer. |
149+
| | `instructions` | - | Custom instruction for each question |
149150
| | `options` | - | An array of answer options. |
150151

151152
{{< alert type="warning" title="Quick heads up" >}}
@@ -169,6 +170,7 @@ Layer5 Academy supports three question formats:
169170
text: "Test single choice question"
170171
type: "single-answer" # choose the type
171172
marks: 1
173+
instructions: "Only one option is correct"
172174
options:
173175
- id: "a"
174176
text: "Option A"
@@ -204,6 +206,7 @@ Layer5 Academy supports three question formats:
204206
text: "Test multiple choice question"
205207
type: "multiple-answers" # choose the type
206208
marks: 2
209+
instructions: "More then one answer can be correct"
207210
options:
208211
- id: "a"
209212
text: "Option A"
@@ -233,6 +236,7 @@ Layer5 Academy supports three question formats:
233236
text: "In Kubernetes, ___ is the default namespace."
234237
type: "short_answer" # choose the type
235238
marks: 2
239+
instructions: "Just type the command"
236240
correct_answer: "default" # expected answer
237241

238242
- id: "question5"
@@ -283,6 +287,49 @@ A exam is considered final if:
283287
To ensure the final exam is always clear and uniquely identified, we don't use the `weight` field, which can be ambiguous (e.g., missing or duplicated across files). Instead, we rely on the file path order as a more stable and reliable standard.
284288
{{< /alert >}}
285289

290+
## About Instructions
291+
292+
Instructions are a way to help or clarify what the question is trying to ask , and user doesnt get confused .
293+
294+
Instructions are defaultly defined for each question type :
295+
- single-answer: Select one answer
296+
- multiple-answers: Select all that apply
297+
- short_answer: Type your answer below
298+
299+
300+
Instructions can be override in frontmatter by defining a custom intruction for each question.
301+
302+
<details style="margin-bottom: 1em;">
303+
<summary>Examples: <code>Instruction</code> </summary>
304+
305+
---
306+
questions:
307+
- id: "question4"
308+
text: "In Kubernetes, ___ is the default namespace."
309+
type: "short_answer"
310+
marks: 2
311+
instructions: "Just type the command" #custom instruction
312+
correct_answer: "default"
313+
314+
questions: # will display the default instructions for question type
315+
- id: "question3"
316+
text: "Test multiple choice question"
317+
type: "multiple-answers" # choose the type
318+
marks: 2
319+
options:
320+
- id: "a"
321+
text: "Option A"
322+
is_correct: true # correct option
323+
- id: "b"
324+
text: "Option B"
325+
- id: "c"
326+
text: "Option C"
327+
is_correct: true # correct option
328+
---
329+
</code></pre>
330+
</details>
331+
332+
286333
## Scoring
287334

288335
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 `passing_percentage` for the assessment. Here is how the system processes the scores:

0 commit comments

Comments
 (0)