From d522d105ad57a5c3b6364efd01e579441694ab45 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Fri, 13 Jan 2017 11:57:00 -0800 Subject: [PATCH] [Plugins] Document plugins --- API.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/API.md b/API.md index 9b90f0ef49..f3717d95c3 100644 --- a/API.md +++ b/API.md @@ -269,12 +269,27 @@ The plugin will be invoked to configure Open MCT before it is started. Open MCT is packaged along with a few general-purpose plugins: +* `openmct.plugins.CouchDB` is an adapter for using CouchDB for persistence + of user-created objects. This is a constructor that takes the URL for the + CouchDB database as a parameter, e.g. + `openmct.install(new openmct.plugins.CouchDB('http://localhost:5984/openmct'))` +* `openmct.plugins.Elasticsearch` is an adapter for using Elasticsearch for + persistence of user-created objects. This is a + constructor that takes the URL for the Elasticsearch instance as a + parameter, e.g. + `openmct.install(new openmct.plugins.CouchDB('http://localhost:9200'))`. + Domain objects will be indexed at `/mct/domain_object`. +* `openmct.plugins.espresso` and `openmct.plugins.snow` are two different + themes (dark and light) available for Open MCT. Note that at least one + of these themes must be installed for Open MCT to appear correctly. * `openmct.plugins.localStorage` provides persistence of user-created objects in browser-local storage. This is particularly useful in development environments. * `openmct.plugins.myItems` adds a top-level folder named "My Items" when the application is first started, providing a place for a user to store created items. +* `openmct.plugins.utcTimeSystem` provides support for using the time + conductor with UTC time. Generally, you will want to either install these plugins, or install different plugins that provide persistence and an initial folder