search

mieweb / docs

WebChart and EH documentation for the website
1 stars 2 forks source link

readme

WebChart / Enterprise Health Docs

If your are a non-techie looking to contribute to documentation, best use the website and author in Google Drive and make recommendations there.

Overview

This git repo contains the history of documentation for MIE's WebChart based products for public consumption. Its purpose is four fold:

  1. Act as a public facing revision control repository for end-user and adminsitrator documentation linked to the release cycle for WebChart based software. Eg: each version of the documentation is earmarked on a branch RC20YYMM and this documentation will be maintained beside that strategy.
  2. Scripts to maintain the documentation. The source of truth for the "master" branch of the content folder is not this repository. It is instead is stored in a specific Documentation Home folder on a MIE Documentation Google Shared Drive. Changes should be made there (by using "Propose Changes") and when approved in the Google Drive, a tool named wikiGDrive transforms the Google Docs and Google Drawings into Markdown and images (png or svg) to be placed in the content folder.
  3. Scripting tools to transform the Markdown into HTML using Hugo to generate a website for each product branded to its purpose.
  4. Automation in GitHub Enterprise Actions to automate the updating of the public facing websites. Currently there are two: 1) docs.webchartnow.com and 2) docs.enterprisehealth.com

Contents of this project

  1. The content folder contains the Markdown for documentation. Most conributors of documentation will not directly work with the Markdown as it requires a bit more skill than working with Google Docs and Diagrams.
  2. Scripts to get Google changes in to Markdown themes.gohugo.io) for WC and EH.
  3. Hugo stuff
  4. Automation to automate the process as well as a set of scripts to update a qa-server in realtime watching for changes in Google Drive and near instant update.
    • Actions - github scripts that automate changes out to production and test Pull Requests to see if they break the build process.
    • test.sh a script for testing the static page generation locally on your own machine.
    • start-server.sh starts several services that watch for changes in realtime from Google, download, transform and update the page.

Setup

TLDR - for geeks to get started quickly.

Mac Users

From your terminal, clone this repository:

# CHOOSE ONE
# for username and password
git lfs clone https://github.mieweb.com/webchart/docs.git
# -- OR --
# for SSH key
git lfs clone git@github.mieweb.com:webchart/docs.git

Then run the setup script:

./setup.sh
./build.sh

Windows Users

If you do not have Git installed, download and install it.

To install Nodejs and Chocolatey (package manager), go here and choose the Windows (.msi) installer. If you are unsure about your computer being 32 or 64 bit, choose 32.

During the installation, you will reach a screen with a checkbox for installing Chocolatey. Make sure this is checked (it is not checked by default):

Once you have Chocolatey installed, open Git Bash (run as administrator), clone this repository:

git lfs clone https://github.mieweb.com/webchart/docs.git

Then run the setup script:

./setup.sh

Getting Started

Overview

This project uses the following tools:

You will use wikigdrive to download or watch for updates (and download) to the content in your Google Drive Folder. You can use Hugo to:

Getting content from Google Drive:

We will need to run wikigdrive at least once in order to generate the content that Hugo will build the website with. You will need to have the following: