diff options
| author | Andrew Henry <akhenry@gmail.com> | 2022-02-11 22:09:58 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-11 22:09:58 +0300 |
| commit | 058259278c30d3fa782d0e0c5c0b7776bd3108ad (patch) | |
| tree | a8b7bb0a0e6f20bc7282384a0c3c3b1436f94008 /README.md | |
| parent | 345285b966452ce26fc0408cc2a66ce37d0072ab (diff) | |
Remove legacy codebase (#4844)
* Remove legacy codebase
* Remove legacy docs
* Fixed memory leak in timer spec
* Remove Angular dependency
* Removed adapter layer
* Removed legacy support plugin from main Open MCT repo
* Restored TelemetryAPI.js which had been inexplicably deleted?
* Fix linting error
* Drop line coverage threshold due to removed code
* Added a section on Open MCT 2.0.0 to the readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 16 insertions, 5 deletions
@@ -11,6 +11,22 @@ Once you've created something amazing with Open MCT, showcase your work in our G Try Open MCT now with our [live demo](https://openmct-demo.herokuapp.com/).  +## Open MCT v2.0.0 +Support for our legacy bundle-based API, and the libraries that it was built on (like Angular 1.x), have now been removed entirely from this repository. + +For now if you have an Open MCT application that makes use of the legacy API, [a plugin](https://github.com/nasa/openmct-legacy-plugin) is provided that bootstraps the legacy bundling mechanism and API. This plugin will not be maintained over the long term however, and the legacy support plugin will not be tested for compatibility with future versions of Open MCT. It is provided for convenience only. + +### How do I know if I am using legacy API? +You might still be using legacy API if your source code + +* Contains files named bundle.js, or bundle.json, +* Makes calls to `openmct.$injector()`, or `openmct.$angular`, +* Makes calls to `openmct.legacyRegistry`, `openmct.legacyExtension`, or `openmct.legacyBundle`. + + +### What should I do if I am using legacy API? +Please refer to [the modern Open MCT API](https://nasa.github.io/openmct/documentation/). Post any questions to the [Discussions section](https://github.com/nasa/openmct/discussions) of the Open MCT GitHub repository. + ## Building and Running Open MCT Locally Building and running Open MCT in your local dev environment is very easy. Be sure you have [Git](https://git-scm.com/downloads) and [Node.js](https://nodejs.org/) installed, then follow the directions below. Need additional information? Check out the [Getting Started](https://nasa.github.io/openmct/getting-started/) page on our website. @@ -30,11 +46,6 @@ Building and running Open MCT in your local dev environment is very easy. Be sur Open MCT is now running, and can be accessed by pointing a web browser at [http://localhost:8080/](http://localhost:8080/) -## Open MCT v1.0.0 -This represents a major overhaul of Open MCT with significant changes under the hood. We aim to maintain backward compatibility but if you do find compatibility issues, please let us know by filing an issue in this repository. If you are having major issues with v1.0.0 please check-out the v0.14.0 tag until we can resolve them for you. - -If you are migrating an application built with Open MCT as a dependency to v1.0.0 from an earlier version, please refer to [our migration guide](https://nasa.github.io/openmct/documentation/migration-guide). - ## Documentation Documentation is available on the [Open MCT website](https://nasa.github.io/openmct/documentation/). |