Merge pull request #122 from dhis2/docs/add-user-docs

docs: add user docs
dhis2 · Oct 29, 2021 · 25d66e5 · 25d66e5
2 parents c737678 + 7fa8a09
commit 25d66e5
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 0 deletions.
diff --git a/docs/user/approving_by_category_option_group_set.md b/docs/user/approving_by_category_option_group_set.md
@@ -0,0 +1,3 @@
+# Approving by category option group set { approving_by_category_option_group_set }
+
+Approving by category option group set is not supported in the current version of the Approval App. Support for this will be added in the future.
diff --git a/docs/user/approving_by_workflow.md b/docs/user/approving_by_workflow.md
@@ -0,0 +1,68 @@
+# Approving by workflow { #approving_by_workflow }
+
+## Selecting data
+
+### Select a workflow
+
+Start by selecting a workflow in the top left of the screen. If you only have access to a single workflow, it will be preselected for you.
+
+![Select a workflow](./assets/select_workflow.png 'Select a workflow')
+
+### Select a period
+
+Then proceed to select a period you would like to approve data for.
+
+![Select a period](./assets/select_period.png 'Select a period')
+
+### Select an organisation unit
+
+Finally, select an organisation unit you would like to approve data for. Each visible organisation unit in the tree is preceded with a status-icon. This icon serves as an indication of the actions available to your user profile for that organisation unit. In the screenshot below, "Badjia" is an organisation unit with status "ready for approval".
+
+![Select an organisation unit](./assets/select_org_unit.png 'Select an organisation unit')
+
+### Clear selection
+
+Once a workflow, period, and organisation unit have been selected, a "clear selections" button will appear. This button can be used to quickly clear all three fields and start a fresh selection.
+
+## Approving data
+
+### Review dataset reports
+
+Once a workflow, period, and organisation unit have been selected, you can review the dataset reports for the datasets connected to the selected workflow. The data for each dataset is presented in a tab.
+
+Datasets can have different period types than the workflow the are connected to. If this is the case, the approval app will show data for all the dataset-periods that end within the selected workflow period.
+
+![Review dataset reports](./assets/review_data.png 'Review dataset reports')
+
+### Take an approval action
+
+Once you have reviewed the data in the datasets, you can proceed to take an approval action. The following actions are available:
+
+-   Approve
+-   Accept
+-   Unapprove
+-   Unaccept
+
+Which of these actions are available for a given workflow at a given moment in time depends on the type of actions which have been taken already at the current and other levels of the organisational hierarchy.
+
+In the example above the "approve" action is available. When you choose the "approve" action, you are presented with a confirmation dialog as displayed below which summarises the datasets you are approving. The workflow is not approved until you click "approve" to confirm there. Other actions take effect immediately and do not have a confirmation step.
+
+![Take an approval action](./assets/approval_confirmation.png 'Take an approval action')
+
+After taking one of the approval actions, in this case after confirming the approval, the workflow is updated immediately and you see a the new approval status.
+
+![Updated approval status](./assets/approval_saved.png 'Updated approval status')
+
+### Approval status tags
+
+As shown in the image above, the approval status is displayed in two places:
+
+1. Above the dataset tabs, after the workflow information
+1. Before the buttons on the bottom bar
+
+These status tags may not always display the same information, because the have a slightly different meaning:
+
+1. The status tag above the dataset represents the approval status of the workflow for the selected period and selected organisation unit
+2. The status tag in the bottom bar does the same, but also takes your user profile.
+
+Perhaps a workflow is ready to be approved at a given organisation unit level, but you do not have the appropriate authority to do so.
diff --git a/docs/user/assets/approval_confirmation.png b/docs/user/assets/approval_confirmation.png
diff --git a/docs/user/assets/approval_saved.png b/docs/user/assets/approval_saved.png
diff --git a/docs/user/assets/review_data.png b/docs/user/assets/review_data.png
diff --git a/docs/user/assets/select_org_unit.png b/docs/user/assets/select_org_unit.png
diff --git a/docs/user/assets/select_period.png b/docs/user/assets/select_period.png
diff --git a/docs/user/assets/select_workflow.png b/docs/user/assets/select_workflow.png
diff --git a/docs/user/index.md b/docs/user/index.md
@@ -0,0 +1,6 @@
+# Approval app
+
+## Table of contents
+
+-   [Approving by workflow](approving_by_workflow.md)
+-   [Approving by category option group set](approving_by_category_option_group_set.md)
diff --git a/docs/user/index.yml b/docs/user/index.yml
@@ -0,0 +1,2 @@
+- Approving by workflow: 'approving_by_workflow.md'
+- Approving by category option group set: 'approving_by_category_option_group_set.md'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Approving by category option group set { approving_by_category_option_group_set }

		Approving by category option group set is not supported in the current version of the Approval App. Support for this will be added in the future.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		- Approving by workflow: 'approving_by_workflow.md'
		- Approving by category option group set: 'approving_by_category_option_group_set.md'