From 0aae2c7b2c201ac0758ae00d5b8a25d47f4616dd Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Thu, 24 Dec 2015 15:50:28 -0800 Subject: [PATCH] [API Redesign] Add clarifying comments --- docs/src/design/planning/APIRefactor.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/src/design/planning/APIRefactor.md b/docs/src/design/planning/APIRefactor.md index ba3d2d395a..8f693cb814 100644 --- a/docs/src/design/planning/APIRefactor.md +++ b/docs/src/design/planning/APIRefactor.md @@ -4,7 +4,7 @@ This document summarizes a path toward implementing API changes from the [API Redesign](../proposals/APIRedesign.md) for Open MCT Web v1.0.0. -# Goals and Priorities +# Goals These plans are intended to minimize: @@ -17,6 +17,10 @@ These plans are intended to minimize: # Plan ```nomnoml +#comment: This diagram is in nomnoml syntax and should be rendered. +#comment: See https://github.com/nasa/openmctweb/issues/264#issuecomment-167166471 + + [ Start]->[ Imperative bundle registration] [ Imperative bundle registration]->[ Build and packaging] @@ -133,9 +137,10 @@ Benefits: written here to defer the task of making changes ubiquitously throughout bundles, allowing for earlier validation and verification of those changes, and avoiding ubiquitous changes - which might require us to go dark. (Avoids a - ["greenfield paradox"](http://stepaheadsoftware.blogspot.com/2012/09/greenfield-or-refactor-legacy-code-base.html). - + which might require us to go dark. (Mitigates + ["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: