README.md

# Parashift Module Documenation

This repository is an `mkdocs` project that provides the documentation to Parashift's Modules


## Requirements

Requires:

* [python with pip](https://www.python.org/)
* [yarn](https://yarnpkg.com/lang/en/docs/install/)

### Tool setup

Run these to ensure you have these tools up to date:

```
pip install mkdocs
pip install pygments
```

### Environment setup

```
pip install -r requirements.txt
yarn install
```

### Apache Webserver

The following apache config will host a server of the docs under `/opt/docs`:

```
<VirtualHost *:80>
   ServerName docs.parashift.com.au
   Redirect permanent / https://docs.parashift.com.au/
</VirtualHost>

<VirtualHost *:443>
  ServerName docs.parashift.com.au
  SSLEngine On
  SSLProxyEngine On
  ProxyRequests Off
  ProxyPreserveHost On
  SSLCertificateFile /etc/apache2/server.cert
  SSLCACertificateFile /etc/apache2/intermediate.cert
  DocumentRoot /opt/docs/site

<Directory "/opt/docs/site">
  AllowOverride All
  Require all granted
</Directory>
</VirtualHost>
```

### Updating periodically

Using git post hooks you can update the site periodically.

First create a file in `.git/hooks/post-merge` with the following contents:

```
#!/bin/bash

yarn run build
```

Run `chmod +x .git/hooks/post-merge` to ensure it's executable

Then create a cron job accordingly under `/etc/cron.d`:

```
*/15 * * * * root cd /opt/docs && git pull -q >> /var/log/docsupdate.log 2>&1
```

#### Testing

Run `git pull -q` manually after some changes to confirm the post-merge is working