EOEPCA Master System Design Document

Earth Observation Exploitation Platform Common Architecture
Document source (Asciidoc)
Explore the docs »
Published · Report Bug · Request Feature

Table of Contents

• Repository Organisation
• Development
• Published Documentation
• Acknowledgements

Repository Organisation

The document source is in the master branch.

The published document is in the gh-pages branch.

The gh-pages branch contains:

• existing published versions, under path published/vX.X
• the current in-progress version (tip of master), under path current/
• a landing page with links to the above

The Travis automated build generates the HTML/PDF from the Asciidoc in the master branch, and publishes this to current/ in the gh-pages branch.

Development

During document authoring, the scripts used by the Travis automation pipeline can be executed locally.

In particular the document generation step...

./docs/bin/generate-docs.sh

The document generation relies upon docker to execute the asciidoctor command as a container, avoiding the need to install asciidoctor locally, (ref https://hub.docker.com/r/asciidoctor/docker-asciidoctor).

Thus, you need to have installed docker locally in your development platform to support this.

There is also a helper script to present the generated document through a local HTTP server...

./docs/bin/serve.sh

Published Documentation

The published document is at https://eoepca.github.io/master-system-design/.

Acknowledgements

• README.md is based on this template by Othneil Drew.