chore(docs): integrate docs

dhis2 · Mar 5, 2022 · c686e79 · c686e79
1 parent c60dd2a
commit c686e79
Show file tree

Hide file tree

Showing 127 changed files with 1,106 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
@@ -11,8 +11,8 @@ cypress.env.json
 /build
 /buildzip
 
-# docs
-/docs
+# jsdoc
+/jsdoc
 
 # misc
 .DS_Store

diff --git a/docs/user/index.md b/docs/user/index.md
@@ -0,0 +1,5 @@
+# Capture app
+
+## Table of contents
+
+-   [Using the Capture app](using-the-capture-app.md)
diff --git a/docs/user/index.yml b/docs/user/index.yml
@@ -0,0 +1 @@
+- Capture: 'using-the-capture-app.md'
diff --git a/docs/user/resources/images/auto-generated-01.png b/docs/user/resources/images/auto-generated-01.png
diff --git a/docs/user/resources/images/auto-generated-02.png b/docs/user/resources/images/auto-generated-02.png
diff --git a/docs/user/resources/images/auto-generated-03.png b/docs/user/resources/images/auto-generated-03.png
diff --git a/docs/user/resources/images/auto-generated-04.png b/docs/user/resources/images/auto-generated-04.png
diff --git a/docs/user/resources/images/auto-generated-05.png b/docs/user/resources/images/auto-generated-05.png
diff --git a/docs/user/resources/images/auto-generated-06.png b/docs/user/resources/images/auto-generated-06.png
diff --git a/docs/user/resources/images/auto-generated-07.png b/docs/user/resources/images/auto-generated-07.png
diff --git a/docs/user/resources/images/auto-generated-08.png b/docs/user/resources/images/auto-generated-08.png
diff --git a/docs/user/resources/images/create_new_event.png b/docs/user/resources/images/create_new_event.png
diff --git a/docs/user/resources/images/delete_event.png b/docs/user/resources/images/delete_event.png
diff --git a/docs/user/resources/images/download_event_list.png b/docs/user/resources/images/download_event_list.png
diff --git a/docs/user/resources/images/duplicates-maintenance-config-00.png b/docs/user/resources/images/duplicates-maintenance-config-00.png
diff --git a/docs/user/resources/images/duplicates-maintenance-config-01.png b/docs/user/resources/images/duplicates-maintenance-config-01.png
diff --git a/docs/user/resources/images/duplicates-maintenance-config-02.png b/docs/user/resources/images/duplicates-maintenance-config-02.png
diff --git a/docs/user/resources/images/duplicates-maintenance-config-03.png b/docs/user/resources/images/duplicates-maintenance-config-03.png
diff --git a/docs/user/resources/images/duplicates-on-creation-00.png b/docs/user/resources/images/duplicates-on-creation-00.png
diff --git a/docs/user/resources/images/duplicates-on-creation-01.png b/docs/user/resources/images/duplicates-on-creation-01.png
diff --git a/docs/user/resources/images/duplicates-on-creation-02.png b/docs/user/resources/images/duplicates-on-creation-02.png
diff --git a/docs/user/resources/images/duplicates-on-creation-03.png b/docs/user/resources/images/duplicates-on-creation-03.png
diff --git a/docs/user/resources/images/duplicates-on-creation-04.png b/docs/user/resources/images/duplicates-on-creation-04.png
diff --git a/docs/user/resources/images/duplicates-on-creation-05.png b/docs/user/resources/images/duplicates-on-creation-05.png
diff --git a/docs/user/resources/images/enrollment-add-event-schedule-page.png b/docs/user/resources/images/enrollment-add-event-schedule-page.png
diff --git a/docs/user/resources/images/enrollment-dash-01.png b/docs/user/resources/images/enrollment-dash-01.png
diff --git a/docs/user/resources/images/enrollment-dash-02.png b/docs/user/resources/images/enrollment-dash-02.png
diff --git a/docs/user/resources/images/enrollment-dash-03.png b/docs/user/resources/images/enrollment-dash-03.png
diff --git a/docs/user/resources/images/enrollment-dash-05.png b/docs/user/resources/images/enrollment-dash-05.png
diff --git a/docs/user/resources/images/enrollment-dash-06.png b/docs/user/resources/images/enrollment-dash-06.png
diff --git a/docs/user/resources/images/enrollment-dash-07.png b/docs/user/resources/images/enrollment-dash-07.png
diff --git a/docs/user/resources/images/enrollment-dash-08.png b/docs/user/resources/images/enrollment-dash-08.png
diff --git a/docs/user/resources/images/enrollment-dash-09.png b/docs/user/resources/images/enrollment-dash-09.png
diff --git a/docs/user/resources/images/enrollment-dash-10.png b/docs/user/resources/images/enrollment-dash-10.png
diff --git a/docs/user/resources/images/enrollment-dash-11.png b/docs/user/resources/images/enrollment-dash-11.png
diff --git a/docs/user/resources/images/enrollment-dash-12.png b/docs/user/resources/images/enrollment-dash-12.png
diff --git a/docs/user/resources/images/enrollment-dash-enrollment-widget-1.png b/docs/user/resources/images/enrollment-dash-enrollment-widget-1.png
diff --git a/docs/user/resources/images/enrollment-dash-enrollment-widget-2.png b/docs/user/resources/images/enrollment-dash-enrollment-widget-2.png
diff --git a/docs/user/resources/images/enrollment-dash-enrollment-widget-3.png b/docs/user/resources/images/enrollment-dash-enrollment-widget-3.png
diff --git a/docs/user/resources/images/enrollment-dash-error-widget-1.png b/docs/user/resources/images/enrollment-dash-error-widget-1.png
diff --git a/docs/user/resources/images/enrollment-dash-feedback-widget-1.png b/docs/user/resources/images/enrollment-dash-feedback-widget-1.png
diff --git a/docs/user/resources/images/enrollment-dash-indicator-widget-1.png b/docs/user/resources/images/enrollment-dash-indicator-widget-1.png
diff --git a/docs/user/resources/images/enrollment-dash-stages-events-01.png b/docs/user/resources/images/enrollment-dash-stages-events-01.png
diff --git a/docs/user/resources/images/enrollment-dash-stages-events-02.png b/docs/user/resources/images/enrollment-dash-stages-events-02.png
diff --git a/docs/user/resources/images/enrollment-dash-stages-events-03.png b/docs/user/resources/images/enrollment-dash-stages-events-03.png
diff --git a/docs/user/resources/images/enrollment-dash-stages-events-04.png b/docs/user/resources/images/enrollment-dash-stages-events-04.png
diff --git a/docs/user/resources/images/enrollment-dash-stages-events-05.png b/docs/user/resources/images/enrollment-dash-stages-events-05.png
diff --git a/docs/user/resources/images/enrollment-dash-stages-events-06.png b/docs/user/resources/images/enrollment-dash-stages-events-06.png
diff --git a/docs/user/resources/images/enrollment-dash-stages-events-07.png b/docs/user/resources/images/enrollment-dash-stages-events-07.png
diff --git a/docs/user/resources/images/enrollment-dash-stages-events-08.png b/docs/user/resources/images/enrollment-dash-stages-events-08.png
diff --git a/docs/user/resources/images/enrollment-dash-tei-profile-widget-edit.png b/docs/user/resources/images/enrollment-dash-tei-profile-widget-edit.png
diff --git a/docs/user/resources/images/enrollment-dash-tei-profile-widget.png b/docs/user/resources/images/enrollment-dash-tei-profile-widget.png
diff --git a/docs/user/resources/images/enrollment-dash-warning-widget-1.png b/docs/user/resources/images/enrollment-dash-warning-widget-1.png
diff --git a/docs/user/resources/images/enrollment-dashboard-quick-actions.png b/docs/user/resources/images/enrollment-dashboard-quick-actions.png
diff --git a/docs/user/resources/images/enrollment-event-new-navigation.png b/docs/user/resources/images/enrollment-event-new-navigation.png
diff --git a/docs/user/resources/images/enrollment-event-new-stage-selection-list.png b/docs/user/resources/images/enrollment-event-new-stage-selection-list.png
diff --git a/docs/user/resources/images/enrollment-event-view-edit-edit.png b/docs/user/resources/images/enrollment-event-view-edit-edit.png
diff --git a/docs/user/resources/images/enrollment-event-view-edit-header.png b/docs/user/resources/images/enrollment-event-view-edit-header.png
diff --git a/docs/user/resources/images/enrollment-event-view-edit-navigation.png b/docs/user/resources/images/enrollment-event-view-edit-navigation.png
diff --git a/docs/user/resources/images/enrollment-event-view-edit-view.png b/docs/user/resources/images/enrollment-event-view-edit-view.png
diff --git a/docs/user/resources/images/enrollment-event-view-edit-widgets.png b/docs/user/resources/images/enrollment-event-view-edit-widgets.png
diff --git a/docs/user/resources/images/enrollment-widget-comment.png b/docs/user/resources/images/enrollment-widget-comment.png
diff --git a/docs/user/resources/images/event-widget-comment.png b/docs/user/resources/images/event-widget-comment.png
diff --git a/docs/user/resources/images/event_list.png b/docs/user/resources/images/event_list.png
diff --git a/docs/user/resources/images/filter_event.png b/docs/user/resources/images/filter_event.png
diff --git a/docs/user/resources/images/main-page-all-accessible-records.png b/docs/user/resources/images/main-page-all-accessible-records.png
diff --git a/docs/user/resources/images/modify_event_list.png b/docs/user/resources/images/modify_event_list.png
diff --git a/docs/user/resources/images/new-event-widget-form-header.png b/docs/user/resources/images/new-event-widget-form-header.png
diff --git a/docs/user/resources/images/program-rules-on-creation-00.png b/docs/user/resources/images/program-rules-on-creation-00.png
diff --git a/docs/user/resources/images/program-rules-on-creation-01.png b/docs/user/resources/images/program-rules-on-creation-01.png
diff --git a/docs/user/resources/images/program-rules-on-creation-02.png b/docs/user/resources/images/program-rules-on-creation-02.png
diff --git a/docs/user/resources/images/program-stage-event-list-header.png b/docs/user/resources/images/program-stage-event-list-header.png
diff --git a/.../resources/images/register-and-enroll-dropdown-button-new-person-in-program.png b/.../resources/images/register-and-enroll-dropdown-button-new-person-in-program.png
diff --git a/docs/user/resources/images/register-and-enroll-form.png b/docs/user/resources/images/register-and-enroll-form.png
diff --git a/docs/user/resources/images/register-and-enroll-program-selection.png b/docs/user/resources/images/register-and-enroll-program-selection.png
diff --git a/.../user/resources/images/register-without-enrollment-dropdown-menu-with-arrow.png b/.../user/resources/images/register-without-enrollment-dropdown-menu-with-arrow.png
diff --git a/docs/user/resources/images/register-without-enrollment-dropdown-menu.png b/docs/user/resources/images/register-without-enrollment-dropdown-menu.png
diff --git a/docs/user/resources/images/register-without-enrollment-form.png b/docs/user/resources/images/register-without-enrollment-form.png
diff --git a/docs/user/resources/images/register-without-enrollment-new-button.png b/docs/user/resources/images/register-without-enrollment-new-button.png
diff --git a/docs/user/resources/images/register_tei.png b/docs/user/resources/images/register_tei.png
diff --git a/docs/user/resources/images/relationship_options.png b/docs/user/resources/images/relationship_options.png
diff --git a/docs/user/resources/images/search-by-attributes-domain-selector-overview-0.png b/docs/user/resources/images/search-by-attributes-domain-selector-overview-0.png
diff --git a/docs/user/resources/images/search-by-attributes-domain-selector-overview-1.png b/docs/user/resources/images/search-by-attributes-domain-selector-overview-1.png
diff --git a/docs/user/resources/images/search-by-attributes-fallback-overview-0.png b/docs/user/resources/images/search-by-attributes-fallback-overview-0.png
diff --git a/docs/user/resources/images/search-by-attributes-find-button.png b/docs/user/resources/images/search-by-attributes-find-button.png
diff --git a/docs/user/resources/images/search-by-attributes-on-scope-program-overview-0.png b/docs/user/resources/images/search-by-attributes-on-scope-program-overview-0.png
diff --git a/docs/user/resources/images/search-by-attributes-on-scope-program-overview-1.png b/docs/user/resources/images/search-by-attributes-on-scope-program-overview-1.png
diff --git a/docs/user/resources/images/search-by-attributes-on-scope-program-overview-2.png b/docs/user/resources/images/search-by-attributes-on-scope-program-overview-2.png
diff --git a/docs/user/resources/images/search-by-attributes-on-scope-program-overview-3.png b/docs/user/resources/images/search-by-attributes-on-scope-program-overview-3.png
diff --git a/docs/user/resources/images/search-by-attributes-on-scope-program-overview-4.png b/docs/user/resources/images/search-by-attributes-on-scope-program-overview-4.png
diff --git a/docs/user/resources/images/search-by-attributes-on-scope-program-overview-5.png b/docs/user/resources/images/search-by-attributes-on-scope-program-overview-5.png
diff --git a/.../resources/images/search-by-attributes-on-scope-program-overview-pagination.png b/.../resources/images/search-by-attributes-on-scope-program-overview-pagination.png
diff --git a/...ges/search-by-attributes-on-scope-program-overview-too-many-results-message.png b/...ges/search-by-attributes-on-scope-program-overview-too-many-results-message.png
diff --git a/docs/user/resources/images/search-by-attributes-on-scope-tetype-overview-0.png b/docs/user/resources/images/search-by-attributes-on-scope-tetype-overview-0.png
diff --git a/docs/user/resources/images/search-by-attributes-on-scope-tetype-overview-1.png b/docs/user/resources/images/search-by-attributes-on-scope-tetype-overview-1.png
diff --git a/docs/user/resources/images/search-by-attributes-on-scope-tetype-overview-2.png b/docs/user/resources/images/search-by-attributes-on-scope-tetype-overview-2.png
diff --git a/docs/user/resources/images/search_tei.png b/docs/user/resources/images/search_tei.png
diff --git a/docs/user/resources/images/sort_event.png b/docs/user/resources/images/sort_event.png
diff --git a/docs/user/resources/images/tei_list_column_layout.png b/docs/user/resources/images/tei_list_column_layout.png
diff --git a/docs/user/resources/images/tei_list_filter_example.png b/docs/user/resources/images/tei_list_filter_example.png
diff --git a/docs/user/resources/images/tei_list_filters.png b/docs/user/resources/images/tei_list_filters.png
diff --git a/docs/user/resources/images/tei_list_predefined_views.png b/docs/user/resources/images/tei_list_predefined_views.png
diff --git a/docs/user/resources/images/tei_list_sort_order.png b/docs/user/resources/images/tei_list_sort_order.png
diff --git a/docs/user/resources/images/tracker_program.png b/docs/user/resources/images/tracker_program.png
diff --git a/docs/user/resources/images/user_assignment_edit.png b/docs/user/resources/images/user_assignment_edit.png
diff --git a/docs/user/resources/images/user_assignment_edit_add.png b/docs/user/resources/images/user_assignment_edit_add.png
diff --git a/docs/user/resources/images/user_assignment_edit_button.png b/docs/user/resources/images/user_assignment_edit_button.png
diff --git a/docs/user/resources/images/user_assignment_event_list.png b/docs/user/resources/images/user_assignment_event_list.png
diff --git a/docs/user/resources/images/user_assignment_event_list_options.png b/docs/user/resources/images/user_assignment_event_list_options.png
diff --git a/docs/user/resources/images/user_assignment_new.png b/docs/user/resources/images/user_assignment_new.png
diff --git a/docs/user/resources/images/user_assignment_new_filled.png b/docs/user/resources/images/user_assignment_new_filled.png
diff --git a/docs/user/resources/images/view_delete.png b/docs/user/resources/images/view_delete.png
diff --git a/docs/user/resources/images/view_load_selected.png b/docs/user/resources/images/view_load_selected.png
diff --git a/docs/user/resources/images/view_load_unselected.png b/docs/user/resources/images/view_load_unselected.png
diff --git a/docs/user/resources/images/view_save_column_order.png b/docs/user/resources/images/view_save_column_order.png
diff --git a/docs/user/resources/images/view_save_filters.png b/docs/user/resources/images/view_save_filters.png
diff --git a/docs/user/resources/images/view_save_menu.png b/docs/user/resources/images/view_save_menu.png
diff --git a/docs/user/resources/images/view_save_name.png b/docs/user/resources/images/view_save_name.png
diff --git a/docs/user/resources/images/view_save_sort_order.png b/docs/user/resources/images/view_save_sort_order.png
diff --git a/docs/user/resources/images/view_share.png b/docs/user/resources/images/view_share.png
diff --git a/docs/user/resources/images/view_share_access.png b/docs/user/resources/images/view_share_access.png
diff --git a/docs/user/resources/images/view_update.png b/docs/user/resources/images/view_update.png
diff --git a/docs/user/resources/images/working_list_active.png b/docs/user/resources/images/working_list_active.png
diff --git a/docs/user/resources/images/working_lists_available.png b/docs/user/resources/images/working_lists_available.png
diff --git a/docs/user/using-the-capture-app.md b/docs/user/using-the-capture-app.md
diff --git a/jsdoc-conf.json b/jsdoc-conf.json
@@ -22,7 +22,7 @@
     "opts": {
         "template": "node_modules/docdash",
         "encoding": "utf8",
-        "destination": "./docs/",
+        "destination": "./jsdoc/",
         "recurse": true
     },
     "plugins": [

diff --git a/package.json b/package.json
@@ -70,7 +70,7 @@
     "test": "d2-app-scripts test",
     "test:debug": "react-scripts --inspect-brk test --runInBand",
     "test2": "react-scripts test",
-    "docs": "NODE_ENV=development jsdoc -c jsdoc-conf.json",
+    "jsdoc": "NODE_ENV=development jsdoc -c jsdoc-conf.json",
     "linter:check": "eslint -c .eslintrc . --quiet",
     "flow:check": "./node_modules/.bin/flow check ./src",
     "flow:addTypes": "flow-typed install",
-Original file line number
+Diff line change
@@ Expand Up / @@ -11,8 +11,8 @@ cypress.env.json @@
     /build
     /buildzip
-    # docs
-    /docs
+    # jsdoc
+    /jsdoc
     # misc
     .DS_Store
@@ Expand Down @@