doc

Documentations

This directory contains various documentation pages. Here is a short summary of what each file and/or directory is for and how to use them:

• developers.md contains some tips for developers.
• review_process.md describes our review process. Before sending a PR for review, please make sure you understand and follow this.
• schema.md describes the Parquet schema for projecting FHIR resources. The two files Patient_US-Core.schema and Patient_no-extension.schema are example schema files that are referenced from schema.md.
• openhim.md explains how to integrate the pipelines with OpenHIM.

The rest of the files/directories are used for generating our documentation site and are described below.

Documentation site

The docs/ directory contains the content for building our documentation site at google.github.io/fhir-data-pipes. To make changes to these documentations you can follow MkDocs steps, namely:

• Create a Python virtual env.

  virtualenv -p python3 venv
  source ./venv/bin/activate

• Install the requirements:

  pip install -r requirements.txt

• To see local changes, run the dev server and check: http://127.0.0.1:8000/analytics

  mkdocs serve

• To build the pages:

  mkdocs build

• To deploy the pages:

  mkdocs gh-deploy

• Do not commit the generated sites/ directory to the master branch. The docs website at google.github.io/fhir-data-pipes is generated from the gh-pages branch; so sites/ updates only go to this branch.