A website which we can publish for app developers and technical contributors to the decode platform to find detailed technical documentation

Jim Barritt 781510aa00 Adding architecture index 2 years ago
content 781510aa00 Adding architecture index 2 years ago
publisher 9c6d674027 Adds bootstrap template style 2 years ago
.gitignore 0d588f1481 Adding basic site 2 years ago
Makefile 7cd13bcc8b Just putting some basic structure in 2 years ago
README.md 0958f81305 Added WIP warning to README 2 years ago

README.md

Decode Backstage

WARNING!! WORK IN PROGRESS

The site may not generate completely at the moment!

This is an informational website for people wanting to work with the decode platform.

There are three different content areas for the information in this site.

Content Description
consortium Information relevant to the group organisations who have created the DECODE platform
platform People who are contributing to the development of the core platform
applications People who are building applications on top of the DECODE platform

The site is divided into these three sections.

Installation and site generation

It uses a static site generation tool called tekdoc https://github.com/ixcode/tekdoc which is a simple website template engine.

In here there are two directories:

Directory Description
publisher Containing the tech to publish the site as html
content The content of the site

Setup

To get started, install tekdoc according to the instructions.

Once tekdoc has been successfully set-up, cd into this project's tekdoc directory:

cd publisher/tekdoc

Then you can run the website locally with the following command:

./run-local.sh

The website will be running at localhost:8000.