Skip to content

Commit be23aec

Browse files
committed
Update question attributes to kebab-case
Signed-off-by: Nouran Atef <engineer_nouran@yahoo.com>
1 parent f8264ca commit be23aec

File tree

1 file changed

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

1 file changed

+12
-12
lines changed

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -141,13 +141,13 @@ questions:
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. |
144-
| | `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`). |
146-
| | `text` || The text of the question prompt. |
147-
| | `type` || The type of question. Accepted values are `single-answer`, `multiple-answers` or `short_answer`. |
148-
| | `marks` || The number of points awarded for a correct answer. |
149-
| | `instructions` | - | Custom instruction for each question |
150-
| | `options` | - | An array of answer options. |
144+
| | `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`). |
146+
| | `text` || The text of the question prompt. |
147+
| | `type` || The type of question. Accepted values are `single-answer`, `multiple-answers` or `short-answer`. |
148+
| | `marks` || The number of points awarded for a correct answer. |
149+
| | `instructions` | - | Custom instruction for each question |
150+
| | `options` | - | An array of answer options. |
151151

152152
{{< alert type="warning" title="Quick heads up" >}}
153153
Remember: `type: "test"` are fixed values that cannot be modified. The system needs these exact words to work properly.
@@ -228,20 +228,20 @@ Layer5 Academy supports three question formats:
228228
- Direct text input
229229

230230
<details style="margin-bottom: 1em;">
231-
<summary>Examples: <code>type: short_answer</code> </summary>
231+
<summary>Examples: <code>type: short-answer</code> </summary>
232232

233233
---
234234
questions:
235235
- id: "question4"
236236
text: "In Kubernetes, ___ is the default namespace."
237-
type: "short_answer" # choose the type
237+
type: "short-answer" # choose the type
238238
marks: 2
239239
instructions: "Just type the command"
240240
correct_answer: "default" # expected answer
241241

242242
- id: "question5"
243243
text: "Which kubectl command lists all pods?"
244-
type: "short_answer" # choose the type
244+
type: "short-answer" # choose the type
245245
marks: 2
246246
correct_answer: "kubectl get pods" # expected answer
247247
---
@@ -294,7 +294,7 @@ Instructions are a way to help or clarify what the question is trying to ask , a
294294
Instructions are defaultly defined for each question type :
295295
- single-answer: Select one answer
296296
- multiple-answers: Select all that apply
297-
- short_answer: Type your answer below
297+
- short-answer: Type your answer below
298298

299299

300300
Instructions can be override in frontmatter by defining a custom intruction for each question.
@@ -306,7 +306,7 @@ Instructions can be override in frontmatter by defining a custom intruction for
306306
questions:
307307
- id: "question4"
308308
text: "In Kubernetes, ___ is the default namespace."
309-
type: "short_answer"
309+
type: "short-answer"
310310
marks: 2
311311
instructions: "Just type the command" #custom instruction
312312
correct_answer: "default"

0 commit comments

Comments
 (0)