/StaticNarrative

A dynamic service for creating and managing Static Narratives

Primary LanguagePythonMIT LicenseMIT

Static Narrative Service


Introduction

This service is used for creating and managing Static Narratives. These are Narratives that are meant to be available for public viewing. They are:

  1. Viewable anonymously through a shareable link.
  2. Non-functional, in that they cannot execute jobs or check on job status.
  3. Non-updateable, each given version of a Static Narrative is tied to a specific version of the original working Narrative that was used to create it.
  4. Partially interactive, while some elements (mainly the App Cells) have most of their interactivity in common with the Narrative Interface, other visualizer cells do not, and link back to their Narrative.

Usage


...

API


Create Static Narrative

...

Contributing


This is a KBase module generated by the KBase Software Development Kit (SDK).

You will need to have the SDK installed to use this module. Learn more about the SDK and how to use it.

Setup and test

Add your KBase developer token to test_local/test.cfg and run the following:

$ make
$ kb-sdk test

After making any additional changes to this repo, run kb-sdk test again to verify that everything still works.

Deployment

This is deployed as all other KBase dynamic services, with a hitch. This needs an extra configured directory mount to put the generated static narratives. This is set internally to the module in deploy.cfg as static-file-root, but must be mounted in the running service externally.

Help

You may find the answers to your questions in our FAQ or Troubleshooting Guide.