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

[API Redesign] Add clarifying comments

Browse Source
This commit is contained in:
Victor Woeltjen
2015-12-24 15:50:28 -08:00
parent b5d7dbc088
commit 0aae2c7b2c
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/src/design/planning/APIRefactor.md
View File

@ -4,7 +4,7 @@ This document summarizes a path toward implementing API changes
from the [API Redesign](../proposals/APIRedesign.md) for Open MCT Web from the [API Redesign](../proposals/APIRedesign.md) for Open MCT Web
v1.0.0. v1.0.0.
# Goals and Priorities # Goals
These plans are intended to minimize: These plans are intended to minimize:
@ -17,6 +17,10 @@ These plans are intended to minimize:
# Plan # Plan
```nomnoml ```nomnoml
#comment: This diagram is in nomnoml syntax and should be rendered.
#comment: See https://github.com/nasa/openmctweb/issues/264#issuecomment-167166471
[<start> Start]->[<state> Imperative bundle registration] [<start> Start]->[<state> Imperative bundle registration]
[<state> Imperative bundle registration]->[<state> Build and packaging] [<state> Imperative bundle registration]->[<state> Build and packaging]
@ -133,9 +137,10 @@ Benefits:
written here to defer the task of making changes ubiquitously written here to defer the task of making changes ubiquitously
throughout bundles, allowing for earlier validation and throughout bundles, allowing for earlier validation and
verification of those changes, and avoiding ubiquitous changes verification of those changes, and avoiding ubiquitous changes
which might require us to go dark. (Avoids a which might require us to go dark. (Mitigates
["greenfield paradox"](http://stepaheadsoftware.blogspot.com/2012/09/greenfield-or-refactor-legacy-code-base.html). ["greenfield paradox"](http://stepaheadsoftware.blogspot.com/2012/09/greenfield-or-refactor-legacy-code-base.html);
want to add value with new API but don't want to discard value
of tested/proven legacy codebase.)
Detriments: Detriments: