ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-01-18 10:46:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
bd7ad85bd7
openmct/docs/src/index.md
Victor Woeltjen 0d894a9f39 [Documentation] Tweak spelling / phrasing 
* Add spaces to 'Open MCT Web' for consistency
* Use term 'platform' instead of 'framework' for consistency
  with the developer guide
* Avoid the term 'capabilities' (could be ambiguous in the context
  of other documentation)
* Use canonical casing for JSDoc and JavaScript
* Simplify phrasing of first sentence
* Change casing of 'Developer Guide' for consistency with
  other bullets

From review of https://github.com/nasa/openmctweb/pull/412
2015-12-11 11:54:23 -08:00

1.4 KiB
Raw Blame History

Open MCT Web Documentation

Overview

Documentation is provided to support the use and development of Open MCT Web. It's recommended that before doing any development with Open MCT Web you take some time to familiarize yourself with the documentation below.

Open MCT Web provides functionality out of the box, but it's also a platform for building rich mission operations applications based on modern web technology. The platform is configured declaratively, and defines conventions for building on the provided capabilities by creating modular 'bundles' that extend the platform at a variety of extension points. The details of how to extend the platform are provided in the following documentation.

Sections

  • The Architecture Overview describes the concepts used throughout Open MCT Web, and gives a high level overview of the platform's design.

  • The Developer's Guide goes into more detail about how to use the platform and the functionality that it provides.

  • The Tutorials give examples of extending the platform to add functionality, and integrate with data sources.

  • The API document is generated from inline documentation using JSDoc, and describes the JavaScript objects and functions that make up the software platform.

  • Finally, the Development Process document describes the Open MCT Web software development cycle.