Skip to content

Commit d60bc08

Browse files
akhenryakhenry
committed
Merge pull request nasa#878 from nasa/open-mct-not-web-816
[Branding] Change name to Open MCT in docs
2 parents 3d62cba + 0070655 commit d60bc08

File tree

15 files changed

+252
-253
lines changed

15 files changed

+252
-253
lines changed

‎CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Open MCT Web
1+
# Contributing to Open MCT
22

3-
This document describes the process of contributing to Open MCT Web as well
3+
This document describes the process of contributing to Open MCT as well
44
as the standards that will be applied when evaluating contributions.
55

66
Please be aware that additional agreements will be necessary before we can
@@ -21,9 +21,9 @@ The short version:
2121

2222
## Contribution Process
2323

24-
Open MCT Web uses git for software version control, and for branching and
24+
Open MCT uses git for software version control, and for branching and
2525
merging. The central repository is at
26-
https://github.com/nasa/openmctweb.git.
26+
https://github.com/nasa/openmct.git.
2727

2828
### Roles
2929

@@ -116,18 +116,18 @@ the merge back to the master branch.
116116

117117
## Standards
118118

119-
Contributions to Open MCT Web are expected to meet the following standards.
119+
Contributions to Open MCT are expected to meet the following standards.
120120
In addition, reviewers should use general discretion before accepting
121121
changes.
122122

123123
### Code Standards
124124

125-
JavaScript sources in Open MCT Web must satisfy JSLint under its default
125+
JavaScript sources in Open MCT must satisfy JSLint under its default
126126
settings. This is verified by the command line build.
127127

128128
#### Code Guidelines
129129

130-
JavaScript sources in Open MCT Web should:
130+
JavaScript sources in Open MCT should:
131131

132132
* Use four spaces for indentation. Tabs should not be used.
133133
* Include JSDoc for any exposed API (e.g. public methods, constructors.)
@@ -159,7 +159,7 @@ JavaScript sources in Open MCT Web should:
159159
* Third, imperative statements.
160160
* Finally, the returned value.
161161

162-
Deviations from Open MCT Web code style guidelines require two-party agreement,
162+
Deviations from Open MCT code style guidelines require two-party agreement,
163163
typically from the author of the change and its reviewer.
164164

165165
#### Code Example
@@ -260,7 +260,7 @@ these standards.
260260

261261
## Issue Reporting
262262

263-
Issues are tracked at https://github.com/nasa/openmctweb/issues
263+
Issues are tracked at https://github.com/nasa/openmct/issues
264264

265265
Issues should include:
266266

‎README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# Open MCT Web
1+
# Open MCT
22

3-
Open MCT Web is a web-based platform for mission operations user interface
3+
Open MCT is a web-based platform for mission operations user interface
44
software.
55

66
## Bundles
77

88
A bundle is a group of software components (including source code, declared
99
as AMD modules, as well as resources such as images and HTML templates)
1010
that are intended to be added or removed as a single unit. A plug-in for
11-
Open MCT Web will be expressed as a bundle; platform components are also
11+
Open MCT will be expressed as a bundle; platform components are also
1212
expressed as bundles.
1313

1414
A bundle is also just a directory which contains a file `bundle.json`,
1515
which declares its contents.
1616

1717
The file `bundles.json` (note the plural), at the top level of the
1818
repository, is a JSON file containing an array of all bundles (expressed as
19-
directory names) to include in a running instance of Open MCT Web. Adding or
19+
directory names) to include in a running instance of Open MCT. Adding or
2020
removing paths from this list will add or remove bundles from the running
2121
application.
2222

@@ -56,26 +56,26 @@ To run:
5656

5757
## Build
5858

59-
Open MCT Web is built using [`npm`](http://npmjs.com/)
59+
Open MCT is built using [`npm`](http://npmjs.com/)
6060
and [`gulp`](http://gulpjs.com/).
6161

6262
To build:
6363

6464
`npm run prepublish`
6565

6666
This will compile and minify JavaScript sources, as well as copy over assets.
67-
The contents of the `dist` folder will contain a runnable Open MCT Web
67+
The contents of the `dist` folder will contain a runnable Open MCT
6868
instance (e.g. by starting an HTTP server in that directory), including:
6969

70-
* A `main.js` file containing Open MCT Web source code.
70+
* A `main.js` file containing Open MCT source code.
7171
* Various assets in the `example` and `platform` directories.
72-
* An `index.html` that runs Open MCT Web in its default configuration.
72+
* An `index.html` that runs Open MCT in its default configuration.
7373

7474
Additional `gulp` tasks are defined in [the gulpfile](gulpfile.js).
7575

7676
### Building Documentation
7777

78-
Open MCT Web's documentation is generated by an
78+
Open MCT's documentation is generated by an
7979
[npm](https://www.npmjs.com/)-based build. It has additional dependencies that
8080
may not be available on every platform and thus is not covered in the standard
8181
npm install. Ensure your system has [libcairo](http://cairographics.org/)
@@ -89,7 +89,7 @@ Documentation will be generated in `target/docs`.
8989

9090
# Glossary
9191

92-
Certain terms are used throughout Open MCT Web with consistent meanings
92+
Certain terms are used throughout Open MCT with consistent meanings
9393
or conventions. Any deviations from the below are issues and should be
9494
addressed (either by updating this glossary or changing code to reflect
9595
correct usage.) Other developer documentation, particularly in-line
@@ -112,7 +112,7 @@ documentation, may presume an understanding of these terms.
112112
(Most often used in the context of extensions, domain
113113
object models, or other similar application-specific objects.)
114114
* _domain object_: A meaningful object to the user; a distinct thing in
115-
the work support by Open MCT Web. Anything that appears in the left-hand
115+
the work support by Open MCT. Anything that appears in the left-hand
116116
tree is a domain object.
117117
* _extension_: An extension is a unit of functionality exposed to the
118118
platform in a declarative fashion by a bundle. For more

‎bower.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"name": "openmctweb",
3-
"description": "The OpenMCTWeb core platform",
2+
"name": "openmct",
3+
"description": "The Open MCT core platform",
44
"main": "",
55
"license": "Apache-2.0",
66
"moduleType": [],
7-
"homepage": "http://nasa.github.io/openmctweb/",
7+
"homepage": "http://nasa.github.io/openmct/",
88
"private": true,
99
"dependencies": {
1010
"angular": "1.4.4",

‎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

0 commit comments

Comments
 (0)