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 notes about 1.0.0 release

Browse Source 
Particularly, closing API-related issues; need for this
mentioned at
https://github.com/nasa/openmctweb/issues/264#issuecomment-165921056
This commit is contained in:
Victor Woeltjen
2015-12-24 15:21:14 -08:00
parent 5921883325
commit b5d7dbc088
1 changed files with 45 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -19,35 +19,38 @@ These plans are intended to minimize:
```nomnoml ```nomnoml
[<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> Refactor API]
[<state> Imperative bundle registration]->[<state> Incorporate a build step] [<state> Build and packaging |
[<start> Start]->[<state> Incorporate a build step]
[<state> Incorporate a build step | [<state> Incorporate a build step |
[<start> Start]->[<state> Choose package manager] [<start> Start]->[<state> Choose package manager]
[<start> Start]->[<state> Choose build system] [<start> Start]->[<state> Choose build system]
[<state> Choose build system]<->[<state> Choose package manager] [<state> Choose build system]<->[<state> Choose package manager]
[<state> Choose package manager]->[<state> Implement] [<state> Choose package manager]->[<state> Implement]
[<state> Choose build system]->[<state> Implement] [<state> Choose build system]->[<state> Implement]
[<state> Implement]->[<end> End] [<state> Implement]->[<end> End]
]->[<state> Separate repositories] ]->[<state> Separate repositories]
[<state> Separate repositories]->[<end> End]
]->[<state> Release candidacy]
[<state> Separate repositories]->[<state> Release candidacy]
[<start> Start]->[<state> Design registration API] [<start> Start]->[<state> Design registration API]
[<state> Imperative bundle registration]->[<state> Imperative extension registration]
[<state> Design registration API | [<state> Design registration API |
[<start> Start]->[<state> Decide on role of Angular] [<start> Start]->[<state> Decide on role of Angular]
[<state> Decide on role of Angular]->[<state> Design API] [<state> Decide on role of Angular]->[<state> Design API]
[<state> Design API]->[<choice> Passes review?] [<state> Design API]->[<choice> Passes review?]
[<choice> Passes review?] no ->[<state> Design API] [<choice> Passes review?] no ->[<state> Design API]
[<choice> Passes review?]-> yes [<end> End] [<choice> Passes review?]-> yes [<end> End]
]->[<state> Imperative extension registration] ]->[<state> Refactor API]
[<state> Imperative extension registration]->[<state> Refactor individual extensions] [<state> Refactor API |
[<start> Start]->[<state> Imperative extension registration]
[<state> Imperative extension registration]->[<state> Refactor individual extensions]
[<state> Refactor individual extensions | [<state> Refactor individual extensions |
[<start> Start]->[<state> Prioritize] [<start> Start]->[<state> Prioritize]
[<state> Prioritize]->[<choice> Sufficient value added?] [<state> Prioritize]->[<choice> Sufficient value added?]
[<choice> Sufficient value added?] no ->[<end> End] [<choice> Sufficient value added?] no ->[<end> End]
@ -56,9 +59,10 @@ These plans are intended to minimize:
[<choice> Passes review?] no ->[<state> Design] [<choice> Passes review?] no ->[<state> Design]
[<choice> Passes review?]-> yes [<state> Implement] [<choice> Passes review?]-> yes [<state> Implement]
[<state> Implement]->[<end> End] [<state> Implement]->[<end> End]
]->[<state> Remove legacy bundle support] ]->[<state> Remove legacy bundle support]
[<state> Remove legacy bundle support]->[<state> Release candidacy] [<state> Remove legacy bundle support]->[<end> End]
]->[<state> Release candidacy]
[<state> Release candidacy | [<state> Release candidacy |
[<start> Start]->[<state> Verify | [<start> Start]->[<state> Verify |
@ -84,7 +88,9 @@ These plans are intended to minimize:
] ]
[<state> Validate]->[<end> End] [<state> Validate]->[<end> End]
[<state> Verify]->[<end> End] [<state> Verify]->[<end> End]
]->[<end> End] ]->[<state> Release]
[<state> Release]->[<end> End]
``` ```
## Step 1. Imperative bundle registration ## Step 1. Imperative bundle registration
@ -311,6 +317,17 @@ candidacy cycle. Important things to look at here:
be installed before initial setup? be installed before initial setup?
* Does the API offer sufficient power to implement the extensions we * Does the API offer sufficient power to implement the extensions we
anticipate? anticipate?
* Any open API-related issues which should block a 1.0.0 release?
Any problems identified during release candidacy will require Any problems identified during release candidacy will require
subsequent design changes and planning. subsequent design changes and planning.
## Step 9. Release
Once API changes have been verified and validated, proceed
with release, including:
* Tagging as version 1.0.0 (at an appropriate time in the
sprint/release cycle.)
* Close any open issues which have been resolved (or made obsolete)
by API changes.