diff --git a/docs/src/design/planning/APIRefactor.md b/docs/src/design/planning/APIRefactor.md index f2e3e98481..ba3d2d395a 100644 --- a/docs/src/design/planning/APIRefactor.md +++ b/docs/src/design/planning/APIRefactor.md @@ -19,46 +19,50 @@ These plans are intended to minimize: ```nomnoml [ Start]->[ Imperative bundle registration] +[ Imperative bundle registration]->[ Build and packaging] +[ Imperative bundle registration]->[ Refactor API] -[ Imperative bundle registration]->[ Incorporate a build step] +[ Build and packaging | + [ Start]->[ Incorporate a build step] + [ Incorporate a build step | + [ Start]->[ Choose package manager] + [ Start]->[ Choose build system] + [ Choose build system]<->[ Choose package manager] + [ Choose package manager]->[ Implement] + [ Choose build system]->[ Implement] + [ Implement]->[ End] + ]->[ Separate repositories] + [ Separate repositories]->[ End] +]->[ Release candidacy] -[ Incorporate a build step | - [ Start]->[ Choose package manager] - [ Start]->[ Choose build system] - [ Choose build system]<->[ Choose package manager] - [ Choose package manager]->[ Implement] - [ Choose build system]->[ Implement] - [ Implement]->[ End] -]->[ Separate repositories] - -[ Separate repositories]->[ Release candidacy] [ Start]->[ Design registration API] -[ Imperative bundle registration]->[ Imperative extension registration] - [ Design registration API | [ Start]->[ Decide on role of Angular] [ Decide on role of Angular]->[ Design API] [ Design API]->[ Passes review?] [ Passes review?] no ->[ Design API] [ Passes review?]-> yes [ End] -]->[ Imperative extension registration] +]->[ Refactor API] -[ Imperative extension registration]->[ Refactor individual extensions] +[ Refactor API | + [ Start]->[ Imperative extension registration] + [ Imperative extension registration]->[ Refactor individual extensions] -[ Refactor individual extensions | - [ Start]->[ Prioritize] - [ Prioritize]->[ Sufficient value added?] - [ Sufficient value added?] no ->[ End] - [ Sufficient value added?] yes ->[ Design] - [ Design]->[ Passes review?] - [ Passes review?] no ->[ Design] - [ Passes review?]-> yes [ Implement] - [ Implement]->[ End] -]->[ Remove legacy bundle support] + [ Refactor individual extensions | + [ Start]->[ Prioritize] + [ Prioritize]->[ Sufficient value added?] + [ Sufficient value added?] no ->[ End] + [ Sufficient value added?] yes ->[ Design] + [ Design]->[ Passes review?] + [ Passes review?] no ->[ Design] + [ Passes review?]-> yes [ Implement] + [ Implement]->[ End] + ]->[ Remove legacy bundle support] -[ Remove legacy bundle support]->[ Release candidacy] + [ Remove legacy bundle support]->[ End] +]->[ Release candidacy] [ Release candidacy | [ Start]->[ Verify | @@ -84,7 +88,9 @@ These plans are intended to minimize: ] [ Validate]->[ End] [ Verify]->[ End] -]->[ End] +]->[ Release] + +[ Release]->[ End] ``` ## Step 1. Imperative bundle registration @@ -311,6 +317,17 @@ candidacy cycle. Important things to look at here: be installed before initial setup? * Does the API offer sufficient power to implement the extensions we anticipate? + * Any open API-related issues which should block a 1.0.0 release? Any problems identified during release candidacy will require -subsequent design changes and planning. \ No newline at end of file +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. \ No newline at end of file