ensign

README

Ensign

An eventing platform that is distributed in time and space.

Quick Start

Build the docker compose images:

$ ./containers/local.sh -p backend build

Then once the images are built run the docker containers:

$ ./containers/local.sh -p backend up

User UI

For details on how to view the Ensign user UI locally, read the Beacon app README.

Documentation

The primary Ensign documentation is published in this repo in the docs/ directory as a Hugo site using the hugo-book theme.

The API documentation will be online on pkg.go.dev when we make this repository open source. Until then you can view the API documentation locally using godoc.

Hugo Documentation

First, ensure you have hugo installed by following the hugo installation instructions for your operating system. On OS X the simplest way to do this is with homebrew:

$ brew install hugo

Change directories into the docs/ directory. Note all of the following commands assume that your current working directory is docs/.

To run the local hugo development server:

$ hugo serve -D

You should now be able to view the docs locally at http://localhost:1313. If you get something that looks like this error:

code: template for shortcode "hint" not found

try

$ git submodule update --init --recursive

To create a new documentation page:

$ hugo new path/to/page.md

This will create a new page with the documentation default template; open in a browser and edit in markdown; your changes should reload live in the browser! Our theme has many options and shortcodes; to see how these work, please visit the theme documentation. A couple of important quick links are below:

• Page Configuration
• Hints and Notification Blocks
• Mermaid Diagrams
• KaTeX math typesetting
• Columns and Tabs

To help with generating and updating markdown tables, we recommend:

• Markdown Table Generator

API Documentation

First, ensure you have godoc installed:

$ go install golang.org/x/tools/cmd/godoc@latest

You can then run the API documentation locally using:

$ godoc --http=:6060

The docs should be available shortly when you open your browser to http://localhost:6060/pkg/github.com/rotationalio/ensign/pkg/.