Adding an Index file to the repo

.github/workflows/docs.yml

@@ -0,0 +1,23 @@
+name: docs
+on:
+  push:    
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: pip install mkdocs-pdf-export-plugin
+      - run: pip install mkdocs-git-revision-date-localized-plugin
+      - run: pip install mknotebooks 
+      - run: mkdocs gh-deploy --force
+
+
+

.gitignore

@@ -109,5 +109,8 @@ Temporary Items
 *.code-workspace
 
 # Local History for Visual Studio Code
-.history/
+.history/ 
+
+#tryout 
+site/docs 
 

README.md

@@ -2,3 +2,4 @@
 
 A technical guide to the design, architecture and implementation considerations for the UgandaEMR distribution based on OpenMRS. This guide provides a starting point for developers, system administrators, and other technical stakeholders to understand the decisions made in this implementation, and how to extend it.
 
+

index.html

@@ -0,0 +1 @@
+<meta http-equiv="refresh" content="0; URL=SUMMARY.html" >

mkdocs.yml

@@ -0,0 +1,28 @@
+# Project information
+site_name: "Uganda EMR Technical Guide"
+site_description: "Technical documentation for Uganda EMR"
+site_author: "METS Programme"
+site_url: "https://github.com/METS-Programme/ugandaemr-technicalguide/"  
+docs_dir: "."
+
+# Repository
+repo_name: "ugandaemr-technicalguide"
+repo_url: "https://github.com/METS-Programme/ugandaemr-technicalguide"
+
+# Copyright
+copyright: "Copyright © 2021 METS Programme"
+
+# Theme
+theme:
+  name: "material"
+  palette:
+    primary: "blue grey"
+    accent: "indigo"
+  language: "en"
+  font:
+    text: "Roboto"
+    code: "Roboto Mono"
+nav:
+  - Home:
+    - 'SUMMARY.md'
+

releasing.md

@@ -95,4 +95,4 @@ Once the release process has been completed the demo site needs to be updated wi
 There are times when performing the release fails, usually due to permission errors (403 Forbidden) or if the servers are not available. In this case the steps below can be used to deploy the artifacts manually 
 
 1. Checkout the tag for the release `git checkout tag`
-2. Run `mvn clean deploy` which compiles the artifacts for the tag and deploys them to the relevant repositories 
+2. Run `mvn clean deploy` which compiles the artifacts for the tag and deploys them to the relevant repositories