Skip to content

Commit

Permalink
chore: add documentation for training materials page (#1712)
Browse files Browse the repository at this point in the history
  • Loading branch information
latin-panda authored Nov 18, 2024
1 parent 09f2888 commit 3244133
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 4 deletions.
3 changes: 2 additions & 1 deletion content/en/building/guides/performance/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,13 @@ Find below the list of telemetry data recorded by CHT:
| `tasks:group:modal:confirm` | Number times the user confirms navigation away from the household tasks page. Added in 3.13. | |
| `tasks:group:modal:reject` | Number times the user rejects navigation away from the household tasks page. Added in 3.13. | |
| `user_settings:language:<language_code>` | The selected language by the user, example: `user_settings:language:en`. Added in 3.14. | |
| `enketo:<training-card>:add:render` | The time it took to render the training card. Added in 4.2.0 | |
| `enketo:<training-card>:add:render` | The time it took to render the training card. Added in 4.2.0 | Yes. Added in 4.15.0 |
| `enketo:<training-card>:add:user_edit_time` | The time the user took to complete the training card. Added in 4.2.0 | |
| `enketo:<training-card>:add:save` | The time it took to save the training card. Added in 4.2.0 | |
| `enketo:<training-card>:add:quit` | The time from when the training card was rendered to when the user quits the training. Added in 4.2.0 | |
| `geolocation:success` | A successful GPS response with the value showing the accuracy. | |
| `geolocation:failure:<x>` | An unsuccessful GPS response. `x` is a constant matching the [GeolocationPositionError](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationPositionError/code) or with one of the following values: `-1` unknown failure, `-2` timeout, or `-3` geolocation services unavailable. | |
| `training_materials_list:load` | On the Training Materials page, the time taken to load the list of trainings on the left hand side. Added in 4.15.0. | Yes. Added in 4.15.0 |

[1] "Dirty" indicates that the contact's task documents are not up to date. They will be refreshed before being used.
[2] Replication can be denied when the user doesn't have permissions to create a doc (hierarchy permissions) or when a doc fails a `validate_doc_update` check.
Expand Down
6 changes: 5 additions & 1 deletion content/en/building/training/training-cards/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,14 @@ _Introduced in 4.2.0_

## Accessing

When health workers open or reload their app, configured training cards will automatically show on top of all other content in the app. If it is not a convenient time to complete the training, they can cancel out at any time and will be prompted again the next day they open their app (training will start from the beginning).
When health workers open or reload their app, configured training cards will automatically show on top of all other content in the app. If it is not a convenient time to complete the training, they can cancel out at any time and will be prompted again the next day they open their app (training will start from the beginning).

{{% alert title="Note" %}} If there are multiple training sets configured to start on the same day, the CHT will determine the order alphabetically based on the form ID. Subsequent training sets will only be displayed once the previous ones are either completed or no longer valid the next day the app is opened. {{% /alert %}}

Training materials can also be accessed in the training page found in the auxiliary menu for users to revisit as needed. Completed training is displayed with a green checkmark. _Added in 4.15.0_.

{{< figure src="training-materials-page.png" link="training-materials-page.png" class="col-10 col-lg-10" >}}

## Completing

Health workers read through each card one by one in a predefined sequence, tapping “Next” on each card. When they are finished reading all cards, they tap “Submit” on the last card. The training set is now considered complete and they can continue using their app. Completed training sets show up on the [main list]({{< relref "building/features/reports/#main-list" >}}) of the Reports tab and they won’t be asked to complete this set again. If there are additional training sets to complete, they will be shown the next day the app is opened.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Create a [properties file]({{< relref "building/tutorials/form-properties#3-defi

```
{
"title": "",
"title": "New workflow",
"context": {
"start_date": "2023-07-13",
"duration": 60,
Expand All @@ -53,7 +53,7 @@ Create a [properties file]({{< relref "building/tutorials/form-properties#3-defi
In the example above, the training cards could be shown to any user with the "nurse" role between July 13, 2023 and September 11, 2023 (inclusive). See more information about these configuration settings below:
| Property | Description |
|---|----|
| "title" | Optional. Enketo’s form title that is displayed under the modal’s header section. Leave this property empty if you don’t need to display a title. |
| "title" | Enketo’s form title that is displayed in the modal’s header section. |
| "start_date" | Optional. Define the training start day using `yyyy-mm-dd` format. If not defined then the training will start immediately. |
| "duration" | Optional. Number of days this training should be active. If not defined then the training will never expire. |
| "user_roles" | Optional. List of user roles that can access this training. If not defined then all users can access the training. |
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3244133

Please sign in to comment.