Jesse Mazzella
4ee68cccd6
docs: better docs and types for the API ( #7796 )
...
* docs: fix type imports in openmct.js
* docs: fix type imports
* docs: fix types for eventHelpers
* docs: types for TypeRegistry
* docs: types for StatusAPI
* docs: fix ObjectAPI types and docs
* docs: more types
* docs: improved types for main entry
* docs: improved types
* fix: unbreak the linting
* chore: remove EventEmitter webpack alias as it hide types
* fix: return type
* fix: parameter type
* fix: types for composables
* chore: add webpack consts to eslintrc
* fix: remove usage of deprecated timeAPI methods and add a ton of docs and types
* docs: update README.md
* lint: clean up API.md
* chore: upgrade eventemitter to v5.0.2
* refactor: update imports for EventEmitter to remove alias
* format: lint
* docs: update types for Views and ViewProviders
* docs: expose common types at the base import level
* docs(types): remove unnecessary tsconfig options
* docs: ActionAPI
* docs: AnnotationAPI
* docs: import common types from the same origin
* docs: FormsAPI & TelemetryAPI types
* docs: FormController, IndicatorAPI
* docs: MenuAPI, ActionsAPI
* docs: `@memberof` is not supported by `tsc` and JSDoc generation so remove it
* docs: RootRegistry and RootObjectProvider
* docs: Transaction + Overlay
* lint: words for the word god
* fix: review comments
2024-07-31 10:46:16 -07:00
Andrew Henry
7f95325816
Add CodeQL badge to readme ( #6803 )
...
Because we're passing and we should be proud of that!
Co-authored-by: John Hill <john.c.hill@nasa.gov>
2023-12-14 07:31:31 -08:00
John Hill
2cc00271b1
[CI] Add CI Troubleshooting doc ( #6988 )
...
* document how to bust cache
* Update TESTING.md
Co-authored-by: David 'Epper' Marshall <epper.marshall@gmail.com>
* add approapriate link
* Update missing troublehshooting doc and combine code-cov docs
* comments
---------
Co-authored-by: David 'Epper' Marshall <epper.marshall@gmail.com>
2023-11-09 08:04:52 -08:00
Jesse Mazzella
d44e06d598
docs: add related repos section to README.md ( #7111 )
...
* docs: add related repos section to README.md
* docs: update related repos section
2023-11-06 16:10:37 -08:00
Even Stensberg
f9db6433a1
docs(readme): indent correctly ( #6996 )
...
* fix(readme): indent correctly
* fix(readme): review
* fix(readme): review
* chore(docs): revise
Co-authored-by: Jesse Mazzella <ozyx@users.noreply.github.com>
* docs: tidy up a bit
---------
Co-authored-by: Jesse Mazzella <ozyx@users.noreply.github.com>
Co-authored-by: Jesse Mazzella <jesse.d.mazzella@nasa.gov>
2023-08-28 19:59:25 +00:00
Even Stensberg
cbac2c1c82
docs(readme): note sections ( #6997 )
...
* fix(readme): note sections
* fix: notes
* fix: notes
* fix(readme): better markdown
---------
Co-authored-by: Jesse Mazzella <ozyx@users.noreply.github.com>
2023-08-28 19:50:20 +00:00
Even Stensberg
a52577e729
feat(tooling): adds nvm ( #6938 )
...
* feat(tooling): adds nvm
* fix(ci): nodev16 -> nodev18
* chore(node): dont modify ci config
* feat(nvm): add lts
* docs(readme): add section on nvm
* fix(docs): revise section
---------
Co-authored-by: John Hill <john.c.hill@nasa.gov>
2023-08-19 13:16:26 -07:00
Jesse Mazzella
10f3e13e4d
chore: modify cspell config and fix all typos ( #6908 )
2023-08-10 16:20:16 +00:00
Simon Waldherr
ceffee9f22
docs: Remove LGTM badge from README ( #6072 )
...
Update README.md
remove LGTM-Badge - Sadly, LGTM.com is no longer available
2023-02-22 23:09:31 +00:00
Andrew Henry
be73b0158a
Remove link to retired live demo ( #6008 )
...
* Remove link to retired live demo
Closes https://github.com/nasa/openmct/issues/6006
Remove link to retired live demo
* Added screenshot
2022-11-28 17:06:55 +00:00
Michael Rogers
026eb86f5f
4417 fix codeql issues ( #5793 )
...
* Add release to codeql and queries to match lgtm
* Add lgtm config file
* Custom codeQL config to ignore app.js
* Custom config for lgtm
* Remove query filter for lgtm
* Updated the security test docs
* Remove lgtm.yml and delete app.js references
* Update codeql-config.yml
Co-authored-by: Alize Nguyen <alizenguyen@gmail.com>
Co-authored-by: Andrew Henry <akhenry@gmail.com>
2022-10-07 16:30:09 +00:00
Scott Bell
2bdac56505
Replace app.js with webpack-dev-server ( #5797 )
2022-09-30 08:17:02 -07:00
Jesse Mazzella
f493f031df
[e2e] Refactor and document our extension of existing Playwright API and RFE features ( #5537 )
2022-07-27 14:31:18 -07:00
John Hill
7b2ff8fa15
[Docs] add browserlist and linting capability ( #4811 )
...
* add browserlist to package.json
* add browserlist linting
* add eslint compat package
* Add blurb about browser support
* add ios safari
* remove node
* add comment and simple disable
Co-authored-by: unlikelyzero <jchill2@gmail.com>
Co-authored-by: Jamie V <jamie.j.vigliotta@nasa.gov>
Co-authored-by: Scott Bell <scott@traclabs.com>
2022-03-21 20:27:18 +01:00
Andrew Henry
058259278c
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
2022-02-11 11:09:58 -08:00
John Hill
324318793d
Include note about node version support in the intro install guide ( #4732 )
2022-01-19 11:45:57 -08:00
John Hill
86e5d10fc1
Add npm badge for the lazy ( #4619 )
...
Co-authored-by: Shefali Joshi <simplyrender@gmail.com>
2022-01-04 11:41:19 -08:00
John Hill
02c2fb5655
Implement e2e functional smoke testing and visual regression testing with playwright ( #4456 )
...
* First example of playwright
* Move config
* set junit output
* fix config and update version
* staged changes
* new files
* update to remote dir
* remove remote
* smoke
* Update smoke.spec.js
* Add eslint for playwright
* Add dependabot rule for playwright
* Add adhoc GHA for playwright
* Update tests and fix eslint
* move playwright eslint config to e2e dir
* Add to circle config
* store artifacts
* wrong location for storing artifacts
* slash?
* build before start
* increase timeouts in circle
* remove duplicate build step
* timeout values
* add retries
* reduce retries
* add percy emblem
* added percy
* Adds GHA for adhoc trigger and baseline visual
* Bump and Rev dependabot separte from karma
* update e2e label for additional pr logic
* Ignore playwright changes for codeql
* Update documentation
* Add ability to run all tests on pr label
* eof
* yamlamlaml
* issue instead of pull api
* archive results and include a link in the PR comment
* log context and attempt string concat
* concat fix
* add success/failure options
* add alure reporting
* lock playwright image
Co-authored-by: unlikelyzero <jchill2@gmail.com>
2021-11-29 16:34:47 -08:00
John Hill
bf7b672957
[CI] Disable html unit test reporting to increase CI Speed ( #4416 )
...
* [CI] Disable html unit test reporting to increase CI Speed
* remove package
* Remove istanbul html reports
* clean up errors
* Update README.md
2021-11-01 09:02:32 -07:00
Jamie V
2a1e322230
adding link to discussions in readme to encourage users to showcase their use of Open MCT ( #3933 )
...
Co-authored-by: Shefali Joshi <simplyrender@gmail.com>
2021-06-22 09:34:36 -07:00
Andrew Henry
c946609d13
Added LGTM code quality badge ( #3960 )
...
We score an A, we should flaunt it! (We should also aim for A+).
2021-06-22 09:10:08 -07:00
Shefali Joshi
ac015c3e45
Updates to the sprint cycle and end of sprint release process ( #3878 )
...
* Updates to the sprint cycle and end of sprint release process
* Adds reviewer checklist item for labelling an issue as a bug
* Update Cycle doc with test process changes.
* Update static.md references, add Issue templates
* Updated criticality definition
Co-authored-by: Jamie V <jamie.j.vigliotta@nasa.gov>
Co-authored-by: John Hill <jchill2.spam@gmail.com>
Co-authored-by: Andrew Henry <akhenry@gmail.com>
2021-05-28 12:24:14 -07:00
Andrew Henry
23781fa686
Correct release number ( #2575 )
2019-12-11 14:16:24 -08:00
Andrew Henry
8ec1b9965a
Updates to README in topic-core-refactor ( #2573 )
...
* Updates to README in topic-core-refactor
In preparation for merge into Master
* Added section on v1.0.0 and link to Migration Guide
* Minor wording change
* More minor wording changes
2019-12-11 10:28:47 -08:00
Pete Richards
0d53898af9
Build refactor to webpack ( #2139 )
...
* Move to webpack build
* Use webpack for building openmct. Move SCSS to one folder and load
all core css up front. Remove bower, begin removing gulp in favor
of npm run.
* Uses eslint instead of jshint and jscs. Merge style checking rules
into .eshintrc.js, carrying over core parts of crockford style and
our adaptations. Current code base fails to pass the linter, want
to separate linter changes from fixes to linting rules.
* Support for Vue SFC with example
* Remove outdated examples
* Use HTML loader for html (supports relative imports of resources e.g.
images) and raw-loader for when javascript must be loaded as text.
2018-08-07 14:47:50 -07:00
Even Stensberg
d34e36831c
prepare -> prepublish
2018-01-04 10:47:14 -08:00
Pete Richards
3dea30b1e1
[README] Remove reference to protractor
...
Since protractor was removed, remove references in readme.
2017-05-18 15:56:43 -07:00
Pete Richards
2a7e6c1173
[Docs] Link to correct tutorial
...
Link to correct tutorial in readme.
Fixes https://github.com/nasa/openmct/issues/1535
2017-04-24 16:29:41 -07:00
Josh Baldwin
9f9d28deef
adding MCT name to README
2017-01-21 11:27:20 -05:00
Victor Woeltjen
b0e842863d
Squashed commit of the following:
...
commit 6b5528a4fc2af993b0bcc762d58b5a219c9348d9f8819ee5b0fa90f8819ee946ce6c6385c3ef0264d864044b1b627d5b6f13f5215b2c0e9aeedd7d8d264208e28018c13b1fe931912b66a4dc874ae72b66a4d60470c810b85dc874ae7afd34e07b9c27c0c5fc5c07aeb62976c9eed102492976c9e70354d2b00e67061f9d6deb1de9d182a7810150d0d71c0999b512774ae03c3e1defee89537b9ac3e7fbf2178e2b430094fea3f77f79abe849f43bb6e03d8f3c3d910e0956811adcbcc5a4e2ca27b6a51887bb04d9db4a7c3bfae0a6471fe7453b0d0526627b43e35179a359634be5653bd8dd9928b5f1f9855511965304fb742d649d386a47df095b0012ca48c134e07b938d230230aa94901846e6c104b8326900aed01d3a93f41fa93f41f1c3#1124 .
commit aed01d3a2309c73ef5f8b1b6080161cb93da5e15d0e7eb29a95e9e6099b06bd1af5c033f20c1bb9491214f26231fde82e6730ae0abcfc36fe1e775e0d4d9f9c4670cb1ec93666ab27302f6dfc5021e119e3a3529e0434ea5487a987d98b45ecc7b987d98b47e53974bd69aed8d331d61f446ed8d331cd37ce9bd97439d94d61f446002763f7dd021cad255ce833b4239fbd915ef89f455c9a0a469f6f926bd9762d79392aeaa9a5bda4917407550e6f48b44b44e388dfa8df28a9e19296b14106632c21c235032a571db41f6e64fe83e0da521c411f8fbe34ce952846cfdab4a614f152f55652fc46c42e57675bf956c3d0a44c48338e4c3412e8a4e1cfac4b90a64e9f5157341ed9d03e2631bdcfd773a7c0c24fdcba665583b1ed7821f1be517f3ea5e3dcadfa4fd97f4df73238745ecc7bb2ba3c3f997cf1ae3ce57d0616e2b4d770e7d812db7c074f29a0792118d353eb111eeff078042e84911631c4b5ddac6baf2dc1f4db7e12d45b1799c695e5761c889bc97cf26d438c4b83b7589d56f30c15a7279c5d8575d53ab83a34565e45b365950daa6cb60800c913e649567176d1df573b8c6bc4ca10e531338f025411cc6833c30a7a47a36d6851d0f0d635a129de73d0cf634a412702d7acf6469a500bf4482e5b009e8aafd0731ecc9705a5f2c7cc4a1262c02904a60817ce9bd969a8cafd2da7e6264ab7bccd0186264ab75f37a5cad2b4dc5027a5cad20ec4de069b39370abd5c1f92a3a61da86018bd022cc4739b36bc3c9b1035a6d676832847560c179eac3a20e8d69b51abcb248fea8151f5f22cdf21f3763341bceb4e20470a02272e3dc26c13096c3d1cac22af778145d5743eeb33af06f714bdcd592bd1035b5f62541ce33ced4bccfe37510dbabf27c41014dbd796f2bebbcc32c76d0ff2ec6690a1e0fb3611d1d4f36a7d90f96fbdd62e05fb57fe4185cdcab0850ccad5aaa6a23df9454ab5b1d3754b309f26b56#1110 and #1111
commit b4dc50295c02aa08a382dde3#1131 from nasa/open1094
Resolve synchronization issues with MutableObject
commit 382dde300ab1b8df402aa08a02aa08a3efc95d9c7d73c505#1121 from nasa/api-containment
[API] Containment
commit c95d9c79561147f3a2463e4d#1107 from nasa/api-type-forms
[API] Handle forms with a "properties" region
commit fd97f4db41b1b8df4d873228a838021dba551fc620f3b57ddd58787c44362a45893602a94ab44431cc9efdff31bd3c6665fb10e90519c0d341a8be978c439d81099c88b7ce1d6e664003e370d804fc4906c184821eb76be3d2e58934ba96f73fb4ce7819#1126 by an EventEmitter.
commit 2463e4d59fd73c505bea831ecc59d91de26d3c5d11409ce50993872ce0748861644f2dd4948f771b0656a298295a0b8295a0bed10656a298dafe2ce91d5014f30b248962d90a811487682607a57bf265b4781d31fe8d02https://github.com/nasa/openmct/pull/999#issuecomment-236045158
commit bfdbc71e401147f3aa47#1097 )
* Include all bundles in artifact
change bundle registry such that all bundles are immediately registered,
but must be specifically enabled. A default registry class enables bundles
that make sense for demonstration purposes.
Added methods to the registry to allow enabling and disabling of bundles
without having to load additional files.
* support alternate asset/worker paths
Change the gulp glob for assets to copy over a more minimal
set of files-- only css, fonts, and images. Results in a
smaller distributable archive.
Update stylesheet loader to use a constant for the assets path.
This can be customized at run time via MCT.setAssetPath() to
allow MCT to be hosted in various locations.
Update worker loader to support loading workers from blobs to
support packaging as standalone file.
* Load templates via requirejs
* [gulp] lazy-require where reasonable
Require things right before starting tasks to reduce gulp start up time.
* document setAssetPath
commit 719f9f45e8#1096 )
commit 95ef70a24c#1070 )
* [API] Allow selection
* [API] Keep in sync using model
* [API] Add selection as EventEmitter
* [API] Use selection from ToDo tutorial
* [API] Restore selection functionality
commit d5aa998b4c#1068 )
* [Objects] util for equality checking
Add a method for checking object equality, useful for other services.
* [Composition] Draft Composition API
Draft composition API. Composition collections provide an observable
for watching and mutating the composition of an object.
Composition providers implement the loading and modification of composition.
The default composition provider uses the composition attribute of
domain objects, while allowing other providers to implement their
own loading and mutation behavior.
* add todo about event listener bindings
* [Type] Add form property for defining form fields
* [tutorial] Add Composition tutorial
* provider doesn't have to implement events, load returns array of children
* use new composition in old api
* correct key name
* Override instantiate to provide model ids
Override instantiate in public API adapter to prevent making changes to
platform code. Instantiate now passes the id of the domain object with the
model so that capabilities can convert to a new-style domain object and use
that to detect functionality.
* Implement mutation capability with decorator
Implementation mutation capability override with decorator to adapter code
outside of platform. Capability override ensures that models are kept in
sync even though they are no longer shared objects.
* override composition cleanly
Override composition capability without making changes inside platform.
* cleanup after temporary collections
* remove unused try/catch
commit 7890fcae69#1079 )
* [API] use new-style objects consistently
* rewrite todo tutorial in test-api.html
* [API] Add API doc, update object API
* [Tutorials] Rename tutorials, remove old
* Fix Links
* updates
* initial
* hope this works
* Object Utils always return new objects instead of mutating existing objects
* keep domain object model in-sync when listening
Keep the domain object model in sync with the latest version when
listening for mutation events.
* Remove old-style plugins
* Update views to use new API
* Tidy Code
* Update API Docs
* Add Plugin API and Example
commit 18843cee48#1072 )
* [API] Allow selection
* [API] Keep in sync using model
* [API] Add selection as EventEmitter
* [API] Use selection from ToDo tutorial
* [API] Add appliesTo-style method
* [API] Remove destroy method, simplify show
* [View] Return a no-op
* [API] Use new applies-to checking
* [API] Rename TodoView to TodoRenderer
* [API] Rewire views
* [API] Wire up so that things work
* [API] Begin adding container
...to attempt to give views something to listen to for destroy-like
events
* [API] Begin using regions...
* [API] Begin working through Region stuff
* [API] Revise Region API
...for similarity with Marionette,
https://github.com/nasa/openmct/pull/1072#issuecomment-230902986
* [API] Begin separating View, ViewDefinition
* [API] Finish separating View/ViewDefinition
* [API] Update MCTView
...to reflect updates to Region/View/ViewDefinition APIs
* [API] Simplify View API
...merging closely-related populate/show methods, and restoring
compatibility with todo tutorial
* [API] Wire in from todo tutorial plugin
* [API] Switch back to region constants
* [API] Update method signature, add JSDoc
* [API] Update variable name
* [API] Remove unnecessary separate regions file
* [API] Relocate Region; not external api
* [API] Revert changes to api.js
...as these ended up becoming entirely superficial
commit 1879c122c7#1074 )
* [API] Allow selection
* [API] Keep in sync using model
* [API] Add selection as EventEmitter
* [API] Use selection from ToDo tutorial
* Object events prototype
* Added examples
* Transitional API
* Modified todo list code to work with new setters
* [API] Removed emitting of events on container when property changes value to remove ambiguity. Listeners must be listening to the same path used in the setter to catch changes
commit d7ddb96c4e#1078 )
* [Bundle] load filter with requirejs
* [Build] Use almond, wrap in UMD
Use almond for built version of application and wrap in UMD so that
it supports requirejs, commonjs, and basic browser loading.
* [Main] Can choose where to load app
MCT.run allows you to specify a dom element to load application
within. If element is not specified, will use body.
* [MCT] set class on injected div
Set class on injected div so extra markup is not required.
* [Build] Re-enable optimize
* Add minimal bootstrap example
commit bccd018d97b55668426d47a543b5b656fa#1062 from nasa/tc-redux
[Time Conductor] V2 Public API
commit 5b656faa9d8d2c489fa94366b0870d#933
commit 47a543beb706f87c1c944080#1067 from nasa/api-css
[API] Remove stylesheet from example
commit 06f87c147214a56eac9c41cd#1029 from nasa/api-toolbar-add-only
[API Prototype] Add toolbar
commit c9c41cdcc8370b51514a56ea14a56ea17ed51e6bfb2e7db7#1028 from nasa/api-view
[API Prototype] Support imperative view registration
commit b2e7db71cc96316ded51e6bfd51e6bfd925de7a96d475d76#1030 from nasa/api-tutorial/objects
Api tutorial/objects
commit d475d767d5a63e053399370b515c234a50f325cbdbe6a4efc113920d8802b6a8c514aae4a4704baabe0029e59a9cb273ef0aeec9b1cf4c1f96e84542c289a27305c94408079096316de6e42240a87ddcd891affe4821a618d1ce580a4e509a833f5de7a96ccc9c4e17b09a833f#1010 from nasa/api-type-proto
[API Prototype] Type registration
commit 09a833f524c4fec1a9c4e17b580a4e52b54ca2f519c4e17b9c4e17bfabd3e5d95d6bc70793ac2da6ef1d34234ca2f51d5e86ac80ddbd0525ba6b0ba79e958ffc03cb0ccb577205faa6bb136f2ae785a07e2fb8e555b531bdeb7ece5897e8a29c7a6eabc4fec1af6aa6996df3df0c660238f2b73b824e551954d986287aa034ce23385dc5d298
2016-09-30 17:31:33 -07:00
Andrew Henry
156ba832f2
Merge pull request #1154 from nasa/root-build-note-1151
...
[README] Warn about root installation issues
2016-09-16 13:36:35 -07:00
Victor Woeltjen
3a25704f41
[README] Add link to KSP plugin
...
Add link to David Hudson's Kerbal Space Program plugin from #1146 ,
along with other information about Examples relevant in that context.
Resolves #1064
2016-08-30 13:55:41 -07:00
Victor Woeltjen
f0064fd91f
[README] Warn about root installation issues
...
Mitigates #1151 .
2016-08-29 10:58:02 -07:00
Andrew Henry
54dcccb472
[Documentation] Add mention of new API to README
...
Added two paragraphs to the readme mentioning the ongoing API work with a link to the tracking task. The website will also link to this.
2016-08-02 14:37:32 -07:00
Andrew Henry
cd21575546
[Documentation] Minor punctuation change, and added links
2016-07-13 08:57:52 -07:00
Andrew Henry
f9d6b9fe5d
Merge pull request #1044 from pacozaa/master
...
[Documentation] Improve README.md in Build section
2016-07-13 08:50:29 -07:00
pacozaa
407766774d
[Documentation] Add Building and Running Open MCT Locally Section from #1044 comment
2016-07-13 15:05:11 +07:00
pacozaa
12b5544959
[Documentation] Edit as Reqeust in #1044 comment
2016-07-09 20:49:05 +07:00
pacozaa
eef08ccb0b
[Documentation]Add convince messages
2016-06-28 13:05:28 +07:00
pacozaa
8a9edd3705
[Documentation] Add Official site
2016-06-28 12:51:12 +07:00
Sarin
8cf7ffc7cc
[Documentation] Add How is NASA Using Open MCT?, Features, See Open MCT in Action, Getting Started Sections
2016-06-27 17:11:27 +07:00
Sarin
b57fc2a0e3
[Documentation] Add getting started section
2016-06-27 16:51:55 +07:00
Andrew Henry
ce87ad2564
Merge pull request #916 from ev1stensberg/patch-2
...
[Branding] Added Apache license to README.md
2016-06-23 11:43:16 -07:00
Sarin
bfc6ed4604
modified README.md for better documentation
2016-06-21 17:09:09 +07:00
Sarin
9cb26b73b5
modified document
2016-06-21 17:02:40 +07:00
mockingjamie
1144f818cf
Proofread readme.md
...
Made minor grammatical corrections.
2016-06-13 21:27:28 -04:00
Even Stensberg
0564759481
Swapped order of license
...
Swaped license order with name
2016-05-10 21:48:24 +02:00
Even Stensberg
24e391edf7
[Branding] Added Apache license to README.md
...
Added Apache license
2016-05-10 21:44:10 +02:00
pacozaa
bcd5f1ee24
add shortcut for see the app quickly
2016-05-09 03:05:21 +07:00
Victor Woeltjen
de2703ee48
[Branding] Remove Web from name at top-level
...
Per #816 , change Open MCT Web to Open MCT in all top-level files.
2016-05-04 10:08:55 -07:00
