Skip to content

Commit 431b836

Browse files
VWoeltjenVWoeltjen
committed
[Branding] Change name in docs hierarchy
...from Open MCT Web to plain-old Open MCT.
1 parent de2703e commit 431b836

File tree

10 files changed

+226
-227
lines changed

10 files changed

+226
-227
lines changed

‎docs/src/architecture/framework.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ software components to communicate. The software components it recognizes
55
are:
66

77
* _Extensions_: Individual units of functionality that can be added to
8-
or removed from Open MCT Web. _Extension categories_ distinguish what
8+
or removed from Open MCT. _Extension categories_ distinguish what
99
type of functionality is being added/removed.
1010
* _Bundles_: A grouping of related extensions
1111
(named after an analogous concept from [OSGi](http://www.osgi.org/))
@@ -19,7 +19,7 @@ manner which the framework layer can understand.
1919

2020
```nomnoml
2121
#direction: down
22-
[Open MCT Web|
22+
[Open MCT|
2323
[Dependency injection framework]-->[Platform bundle #1]
2424
[Dependency injection framework]-->[Platform bundle #2]
2525
[Dependency injection framework]-->[Plugin bundle #1]
@@ -35,7 +35,7 @@ manner which the framework layer can understand.
3535
```
3636

3737
The "dependency injection framework" in this case is
38-
[AngularJS](https://angularjs.org/). Open MCT Web's framework layer
38+
[AngularJS](https://angularjs.org/). Open MCT's framework layer
3939
is really just a thin wrapper over Angular that recognizes the
4040
concepts of bundles and extensions (as declared in JSON files) and
4141
registering extensions with Angular. It additionally acts as a
@@ -60,7 +60,7 @@ activities which were performed by the framework component.
6060

6161
## Application Initialization
6262

63-
The framework component initializes an Open MCT Web application following
63+
The framework component initializes an Open MCT application following
6464
a simple sequence of steps.
6565

6666
```nomnoml
@@ -97,7 +97,7 @@ a simple sequence of steps.
9797
[Extension]o->[Dependency #3]
9898
```
9999

100-
Open MCT Web's architecture relies on a simple premise: Individual units
100+
Open MCT's architecture relies on a simple premise: Individual units
101101
(extensions) only have access to the dependencies they declare that they
102102
need, and they acquire references to these dependencies via dependency
103103
injection. This has several desirable traits:
@@ -121,11 +121,11 @@ injection. This has several desirable traits:
121121
the framework.
122122

123123
A drawback to this approach is that it makes it difficult to define
124-
"the architecture" of Open MCT Web, in terms of describing the specific
124+
"the architecture" of Open MCT, in terms of describing the specific
125125
units that interact at run-time. The run-time architecture is determined
126126
by the framework as the consequence of wiring together dependencies.
127127
As such, the specific architecture of any given application built on
128-
Open MCT Web can look very different.
128+
Open MCT can look very different.
129129

130130
Keeping that in mind, there are a few useful patterns supported by the
131131
framework that are useful to keep in mind.
@@ -229,4 +229,4 @@ otherwise a single provider) will be exposed as a single service that
229229
other extensions can acquire through dependency injection. Because all
230230
components of the same type of service expose the same interface, users
231231
of that service do not need to be aware that they are talking to an
232-
aggregator or a provider, for instance.
232+
aggregator or a provider, for instance.

‎docs/src/architecture/index.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Introduction
22

33
The purpose of this document is to familiarize developers with the
4-
overall architecture of Open MCT Web.
4+
overall architecture of Open MCT.
55

66
The target audience includes:
77

88
* _Platform maintainers_: Individuals involved in developing,
99
extending, and maintaing capabilities of the platform.
1010
* _Integration developers_: Individuals tasked with integrated
11-
Open MCT Web into a larger system, who need to understand
11+
Open MCT into a larger system, who need to understand
1212
its inner workings sufficiently to complete this integration.
1313

1414
As the focus of this document is on architecture, whenever possible
@@ -17,39 +17,39 @@ omitted. These details may be found in the developer guide.
1717

1818
# Overview
1919

20-
Open MCT Web is client software: It runs in a web browser and
20+
Open MCT is client software: It runs in a web browser and
2121
provides a user interface, while communicating with various
2222
server-side resources through browser APIs.
2323

2424
```nomnoml
2525
#direction: right
26-
[Client|[Browser|[Open MCT Web]->[Browser APIs]]]
26+
[Client|[Browser|[Open MCT]->[Browser APIs]]]
2727
[Server|[Web services]]
2828
[Client]<->[Server]
2929
```
3030

31-
While Open MCT Web can be configured to run as a standalone client,
31+
While Open MCT can be configured to run as a standalone client,
3232
this is rarely very useful. Instead, it is intended to be used as a
3333
display and interaction layer for information obtained from a
3434
variety of back-end services. Doing so requires authoring or utilizing
35-
adapter plugins which allow Open MCT Web to interact with these services.
35+
adapter plugins which allow Open MCT to interact with these services.
3636

3737
Typically, the pattern here is to provide a known interface that
38-
Open MCT Web can utilize, and implement it such that it interacts with
38+
Open MCT can utilize, and implement it such that it interacts with
3939
whatever back-end provides the relevant information.
4040
Examples of back-ends that can be utilized in this fashion include
4141
databases for the persistence of user-created objects, or sources of
4242
telemetry data.
4343

4444
## Software Architecture
4545

46-
The simplest overview of Open MCT Web is to look at it as a "layered"
46+
The simplest overview of Open MCT is to look at it as a "layered"
4747
architecture, where each layer more clearly specifies the behavior
4848
of the software.
4949

5050
```nomnoml
5151
#direction: down
52-
[Open MCT Web|
52+
[Open MCT|
5353
[Platform]<->[Application]
5454
[Framework]->[Application]
5555
[Framework]->[Platform]
@@ -64,14 +64,14 @@ These layers are:
6464
established an abstraction by which different software components
6565
may communicate and/or interact.
6666
* [_Platform_](platform.md): The platform layer defines the general look,
67-
feel, and behavior of Open MCT Web. This includes user-facing components like
67+
feel, and behavior of Open MCT. This includes user-facing components like
6868
Browse mode and Edit mode, as well as underlying elements of the
6969
information model and the general service infrastructure.
7070
* _Application_: The application layer defines specific features of
71-
an application built on Open MCT Web. This includes adapters to
71+
an application built on Open MCT. This includes adapters to
7272
specific back-ends, new types of things for users to create, and
7373
new ways of visualizing objects within the system. This layer
74-
typically consists of a mix of custom plug-ins to Open MCT Web,
74+
typically consists of a mix of custom plug-ins to Open MCT,
7575
as well as optional features (such as Plot view) included alongside
7676
the platform.
7777

‎docs/src/architecture/platform.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Overview
22

3-
The Open MCT Web platform utilizes the [framework layer](Framework.md)
3+
The Open MCT platform utilizes the [framework layer](Framework.md)
44
to provide an extensible baseline for applications which includes:
55

66
* A common user interface (and user interface paradigm) for dealing with
@@ -16,7 +16,7 @@ building application, the platform adds more specificity by defining
1616
additional extension types and allowing for integration with back end
1717
components.
1818

19-
The run-time architecture of an Open MCT Web application can be categorized
19+
The run-time architecture of an Open MCT application can be categorized
2020
into certain high-level tiers:
2121

2222
```nomnoml
@@ -29,7 +29,7 @@ into certain high-level tiers:
2929
[Browser APIs]->[Back-end]
3030
```
3131

32-
Applications built using Open MCT Web may add or configure functionality
32+
Applications built using Open MCT may add or configure functionality
3333
in __any of these tiers__.
3434

3535
* _DOM_: The rendered HTML document, composed from HTML templates which
@@ -60,7 +60,7 @@ in __any of these tiers__.
6060
functionality needed to support the information model. This includes
6161
exposing underlying sets of extensions and mediating with the
6262
back-end.
63-
* _Back-end_: The back-end is out of the scope of Open MCT Web, except
63+
* _Back-end_: The back-end is out of the scope of Open MCT, except
6464
for the interfaces which are utilized by adapters participating in the
6565
service infrastructure. Includes the underlying persistence stores, telemetry 
6666
streams, and so forth which the Open MCT Web client is being used to interact 
@@ -70,15 +70,15 @@ in __any of these tiers__.
7070

7171
Once the
7272
[application has been initialized](Framework.md#application-initialization)
73-
Open MCT Web primarily operates in an event-driven paradigm; various
73+
Open MCT primarily operates in an event-driven paradigm; various
7474
events (mouse clicks, timers firing, receiving responses to XHRs) trigger
7575
the invocation of functions, typically in the presentation layer for
7676
user actions or in the service infrastructure for server responses.
7777

78-
The "main point of entry" into an initialized Open MCT Web application
78+
The "main point of entry" into an initialized Open MCT application
7979
is effectively the
8080
[route](https://docs.angularjs.org/api/ngRoute/service/$route#example)
81-
which is associated with the URL used to access Open MCT Web (or a
81+
which is associated with the URL used to access Open MCT (or a
8282
default route.) This route will be associated with a template which
8383
will be displayed; this template will include references to directives
8484
and controllers which will be interpreted by Angular and used to
@@ -107,11 +107,11 @@ both the information model and the service infrastructure.
107107

108108
# Presentation Layer
109109

110-
The presentation layer of Open MCT Web is responsible for providing
110+
The presentation layer of Open MCT is responsible for providing
111111
information to display within templates, and for handling interactions
112112
which are initiated from templated DOM elements. AngularJS acts as
113113
an intermediary between the web page as the user sees it, and the
114-
presentation layer implemented as Open MCT Web extensions.
114+
presentation layer implemented as Open MCT extensions.
115115

116116
```nomnoml
117117
[Presentation Layer|
@@ -143,12 +143,12 @@ to primitives from AngularJS:
143143
attributes and tags.
144144
* [_Routes_](https://docs.angularjs.org/api/ngRoute/service/$route#example)
145145
are used to associate specific URLs (including the fragment identifier)
146-
with specific application states. (In Open MCT Web, these are used to
146+
with specific application states. (In Open MCT, these are used to
147147
describe the mode of usage - e.g. browse or edit - as well as to
148148
identify the object being used.)
149149
* [_Templates_](https://docs.angularjs.org/guide/templates) are partial
150150
HTML documents that will be rendered and kept up-to-date by AngularJS.
151-
Open MCT Web introduces a custom `mct-include` directive which acts
151+
Open MCT introduces a custom `mct-include` directive which acts
152152
as a wrapper around `ng-include` to allow templates to be referred
153153
to by symbolic names.
154154

@@ -189,10 +189,10 @@ to displaying domain objects.
189189
]
190190
```
191191

192-
Domain objects are the most fundamental component of Open MCT Web's
192+
Domain objects are the most fundamental component of Open MCT's
193193
information model. A domain object is some distinct thing relevant to a
194194
user's work flow, such as a telemetry channel, display, or similar.
195-
Open MCT Web is a tool for viewing, browsing, manipulating, and otherwise
195+
Open MCT is a tool for viewing, browsing, manipulating, and otherwise
196196
interacting with a graph of domain objects.
197197

198198
A domain object should be conceived of as the union of the following:
@@ -254,7 +254,7 @@ Concrete examples of capabilities which follow this pattern
254254

255255
# Service Infrastructure
256256

257-
Most services exposed by the Open MCT Web platform follow the
257+
Most services exposed by the Open MCT platform follow the
258258
[composite services](Framework.md#composite-services) to permit
259259
a higher degree of flexibility in how a service can be modified
260260
or customized for specific applications.
@@ -327,7 +327,7 @@ A short summary of the roles of these services:
327327
[DomainObjectProvider]o-[CapabilityService]
328328
```
329329

330-
As domain objects are central to Open MCT Web's information model,
330+
As domain objects are central to Open MCT's information model,
331331
acquiring domain objects is equally important.
332332

333333
```nomnoml
@@ -338,7 +338,7 @@ acquiring domain objects is equally important.
338338
[<state> Instantiate DomainObject]->[<end> End]
339339
```
340340

341-
Open MCT Web includes an implementation of an `ObjectService` which
341+
Open MCT includes an implementation of an `ObjectService` which
342342
satisfies this capability by:
343343

344344
* Consulting the [Model Service](#model-service) to acquire domain object
@@ -437,9 +437,9 @@ objects (this allows failures to be recognized and handled in groups.)
437437
The telemetry service is responsible for acquiring telemetry data.
438438

439439
Notably, the platform does not include any providers for
440-
`TelemetryService`; applications built on Open MCT Web will need to
440+
`TelemetryService`; applications built on Open MCT will need to
441441
implement a provider for this service if they wish to expose telemetry
442-
data. This is usually the most important step for integrating Open MCT Web
442+
data. This is usually the most important step for integrating Open MCT
443443
into an existing telemetry system.
444444

445445
Requests for telemetry data are usually initiated in the
@@ -721,6 +721,6 @@ disallow.
721721
```
722722

723723
The type service provides metadata about the different types of domain
724-
objects that exist within an Open MCT Web application. The platform
724+
objects that exist within an Open MCT application. The platform
725725
implementation reads these types in from extension category `types`
726-
and wraps them in a JavaScript interface.
726+
and wraps them in a JavaScript interface.

0 commit comments

Comments
 (0)