ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-17 14:48:13 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

[Documentation] Tweak spelling / phrasing

Browse Source 
* 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
This commit is contained in:
Victor Woeltjen
2015-12-11 11:54:23 -08:00
parent b6acdb12ec
commit 0d894a9f39
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
docs/src/index.md
View File

@ -1,35 +1,35 @@
# OpenMCTWeb Documentation # Open MCT Web Documentation
## Overview ## Overview
Documentation is provided to support the use and development of the Documentation is provided to support the use and development of
OpenMCTWeb mission operations software. It's recommended that before doing Open MCT Web. It's recommended that before doing
any development with OpenMCTWeb you take some time to familiarize yourself any development with Open MCT Web you take some time to familiarize yourself
with the documentation below. with the documentation below.
OpenMCTWeb provides functionality out of the box, but it's also a framework for 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. building rich mission operations applications based on modern web technology.
The framework is configured declaratively, and defines conventions for The platform is configured declaratively, and defines conventions for
building on the provided capabilities by creating modular 'bundles' that building on the provided capabilities by creating modular 'bundles' that
extend the provided extension points. The details of how to extend the extend the platform at a variety of extension points. The details of how to
framework are provided in the following documentation. extend the platform are provided in the following documentation.
## Sections ## Sections
* The [Architecture Overview](architecture/) describes the concepts used * The [Architecture Overview](architecture/) describes the concepts used
throughout OpenMCTWeb, and gives a high level overview of the framework's design. throughout Open MCT Web, and gives a high level overview of the platform's design.
* The [Developer's guide](guide/) goes into more detail about how to use the * The [Developer's Guide](guide/) goes into more detail about how to use the
framework platform and the functionality that it provides.
and the capabilities that it provides.
* The [Tutorials](tutorials/) give examples of extending the platform to add * The [Tutorials](tutorials/) give examples of extending the platform to add
functionality, functionality,
and integrate with data sources. and integrate with data sources.
* The [API](api/) document is generated from inline documentation * The [API](api/) document is generated from inline documentation
using jsdoc, and describes the javascript objects and functions that make up using [JSDoc](http://usejsdoc.org/), and describes the JavaScript objects and
the software framework. functions that make up the software platform.
* Finally, the [Development Process](process/) document describes the * Finally, the [Development Process](process/) document describes the
OpenMCTWeb software development cycle. Open MCT Web software development cycle.