add docs skeleton, action to build them

.github/workflows/docs.yml

@@ -0,0 +1,20 @@
+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

README.md

@@ -1,5 +1,7 @@
 # Global Open Facility Registry (GOFR)
 
+![docs](https://github.com/intrahealth/gofr/workflows/docs/badge.svg)
+
 This is the main repository for the next iteration of GOFR, which is based on the original codebase of the [Facility Reconciliation Tool](https://github.com/openhie/facility-recon).
 
 The [design document](https://docs.google.com/document/d/1LGzwyxDzH6BmnVn94-V2waCmr0igIhZxxTHD-wnBX50) outlines the next steps in the creation of GOFR based on community feedback.

docs/getting_started/demo_site.md

@@ -0,0 +1 @@
+# Demo site

docs/getting_started/getting_started.md

@@ -0,0 +1,8 @@
+# What is a facility registry?
+
+
+
+
+
+
+

docs/getting_started/using_docker.md

@@ -0,0 +1 @@
+# Using Docker

docs/index.md

@@ -0,0 +1,29 @@
+# Introduction
+
+These are the docs for the next iteration of GOFR, which is based on the original codebase of the [Facility Reconciliation Tool](https://github.com/openhie/facility-recon).
+
+The [design document](https://docs.google.com/document/d/1LGzwyxDzH6BmnVn94-V2waCmr0igIhZxxTHD-wnBX50) outlines the next steps in the creation of GOFR based on community feedback.
+
+If you have ZenHub installed, you may view the [2021 roadmap](https://github.com/intrahealth/gofr/blob/master/LICENSE#workspaces/gofr-60495960906eba0017c751ea/roadmap?repos=346409080).
+
+## Features
+
+GOFR is a GUI on top of the popular and open source HAPI FHIR Server that makes it easier to manage lists of facilities, their hierarchies, services, and attributes.
+
+It supports:
+
+* CSV, DHIS2, and FHIR servers as data sources.
+* Nested lists, ie. facilities that are administrative hierarchies like state->county->hospital.
+* An API and backend engine that use [FHIR](https://www.hl7.org/fhir/location.html) Location resources based on the [mCSD](http://wiki.ihe.net/index.php/Mobile_Care_Services_Discovery_(mCSD)) profile.
+* Modular system to extend algorithms for matching.
+
+Many new features in addition to the above are planned for completion in 2021.
+
+## Contributing and community
+- For immediate support, join the [#gofr](https://ihris.slack.com/archives/C01P3BX8FA7) channel on the iHRIS Slack team.
+- For open monthly discussions, join the [OpenHIE Facility Registry Community](https://wiki.ohie.org/display/SUB/Facility+Registry+Community).
+- Search through or create an [issue](https://github.com/intrahealth/gofr/issues).
+
+## License
+GOFR is distributed under the Apache 2.0 license.
+

docs/server_administration/server_administration.md

@@ -0,0 +1 @@
+# Server administration

docs/working_with_fhir/mcsd.md

@@ -0,0 +1 @@
+# Basics of mCSD

docs/working_with_fhir/working_with_fhir.md

@@ -0,0 +1 @@
+# Working with FHIR and mCSD

mkdocs.yml

@@ -0,0 +1,67 @@
+# Project information
+site_name: "GOFR Documentation"
+site_description: "GOFR Documentation"
+site_author: "IntraHealth"
+site_url: "https://github.com/intrahealth/gofr"
+
+# Repository
+repo_name: "intrahealth/gofr"
+repo_url: "https://github.com/intrahealth/gofr"
+
+# Copyright
+copyright: "Copyright © 2021 IntraHealth International"
+
+# Theme
+theme:
+  name: "material"
+  palette:
+    primary: "indigo"
+    accent: "indigo"
+  language: "en"
+  font:
+    text: "Roboto"
+    code: "Roboto Mono"
+  features:
+    - navigation.expand
+    # - navigation.tabs
+    - toc.integrate
+
+nav:
+  - Welcome to GOFR!:
+    - 'index.md'
+  - Getting started:
+    - 'getting_started/getting_started.md'
+    - 'getting_started/demo_site.md'
+    - 'getting_started/using_docker.md'
+  - Working with FHIR:
+    - 'working_with_fhir/understanding_fhir.md'
+    - 'working_with_fhir/mcsd.md'
+  - Server administration:
+    - 'server_administration/server_administration.md'
+
+markdown_extensions:
+  - admonition
+  - codehilite:
+      guess_lang: false
+  - toc:
+      toc_depth : "3"
+  - footnotes
+
+# https://github.com/zhaoterryy/mkdocs-pdf-export-plugin not working
+plugins:
+  - search
+  - git-revision-date-localized
+  - mknotebooks
+  # - pdf-export:
+  #     combined: true
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/intrahealth/gofr
+
+
+# theme:
+# logo: 'images/logo.png' must be 128x128
+# logo:
+#   icon: 'menu_book'