Add getting started and adjustments (#3335)

* add image * outline of getting started * adjustments to text * add outline for app setup * add outline
opensrp · Jun 17, 2024 · 38fef71 · 38fef71
1 parent ab0bd68
commit 38fef71
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 2 deletions.
diff --git a/docs/engineering/_category_.yml b/docs/engineering/_category_.yml
@@ -1,4 +1,4 @@
 position: 4
 label: 'ENGINEERING'
 collapsible: false
-collapsed: false
+collapsed: false
diff --git a/docs/engineering/getting-started/_category_.yml b/docs/engineering/getting-started/_category_.yml
@@ -0,0 +1,2 @@
+position: 0
+label: 'Getting Started'
diff --git a/docs/engineering/getting-started/app-setup.mdx b/docs/engineering/getting-started/app-setup.mdx
@@ -0,0 +1,35 @@
+# App Setup
+
+This guide assumes you have an existing FHIR Store set up with a typical FHIR Information Gateway connected to a backend Identity and Access Management (IAM) system and transactional FHIR data store with a standard FHIR API.
+
+We will go through the example of setting up an electronic immunization registry (EIR) for a community health worker (CHW) expected to use the app. As we go we will note reusable pieces of functionality and at the end we will reference a number of use cases that can be addressed with a similar pattern.
+
+## Core functions of the EIR for CHWs
+
+### Patient registration
+
+#### Preview of work so far
+
+### Patient list and profile
+
+#### Preview of work so far
+
+### Register vaccine form
+
+#### Preview of work so far
+
+### The completed core app
+
+## Advanced functions of the EIR for CHWs
+
+### Registering households
+
+## Similar use cases
+
+### HIV management
+
+### TB management
+
+### Malaria managment
+
+### Antenatal care
diff --git a/docs/engineering/getting-started/server-setup.mdx b/docs/engineering/getting-started/server-setup.mdx
@@ -0,0 +1,21 @@
+# Server Setup
+
+This guides you through the process of setting up the backend server infrastructure needed to use the OpenSRP 2 app. We then discuss how to deploy optional extensions for administration, data warehousing, integrations, etc.
+
+## FHIR Store
+
+[Example with HAPI FHIR]
+
+## Identity and Access Management (IAM)
+
+[Example with Keycloak]
+
+## FHIR Information Gateway
+
+## Optional extensions
+
+### Admin dashboard
+
+### Data warehouse
+
+### Analytics dashboard
diff --git a/docs/engineering/integrations/dhis2.mdx b/docs/engineering/integrations/dhis2.mdx
@@ -20,7 +20,7 @@ For instances where the OpenSRP 2 app collects data that is defined by the commu
 
 The architecture diagram below shows the overall system architecture and how it integrates with DHIS2. It depicts the components as currently implemented for OpenSRP 2 and the ELT process undertaken by deployed pipelines that is responsible for packaging the expected reporting payloads and pushing them to a target instance of DHIS2 aggregate through the DHIS2's APIs.
 
-[INSERT DIAGRAM 1]
+![DHIS2 architecture diagram](/img/integrations/dhis2-architecture.png)
 
 ### Proposed Integration Process
 

diff --git a/static/img/integrations/dhis2-architecture.png b/static/img/integrations/dhis2-architecture.png