From 7388f4e8bfc884f3bba88f9078cc97f3b26e0bd5 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Wed, 5 Nov 2014 12:25:37 -0800 Subject: [PATCH] [Framework] Add documentation to framework component Add an overview of the stages of framework execution at the bundle level. WTD-518. --- platform/framework/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/platform/framework/README.md b/platform/framework/README.md index 4726e36268..8fbe80d58d 100644 --- a/platform/framework/README.md +++ b/platform/framework/README.md @@ -2,4 +2,22 @@ Framework-level components for Open MCT Web. This is Angular and Require, with an extra layer to mediate between them and act as an extension mechanism to allow plug-ins to be introduced declaratively. +# Implementation Notes +The framework layer is responsible for performing a four-stage initialization +process. These stages are: + +1. __Loading definitions.__ JSON declarations are loaded for all bundles which + will constitute the application, and wrapped in a useful API for subsequent + stages. _Sources in `src/load`_ +2. __Resolving extensions.__ Any scripts which provide implementations for + extensions exposed by bundles are loaded, using Require. + _Sources in `src/resolve`_ +3. __Registering extensions.__ Resolved extensions are registered with Angular, + such that they can be used by the application at run-time. This stage + includes both registration of Angular built-ins (directives, controllers, + routes, and services) as well as registration of non-Angular extensions. + _Sources in `src/register`_ +4. __Bootstrapping.__ JSON declarations are loaded for all bundles which + will constitute the application, and wrapped in a useful API for subsequent + stages. _Sources in `src/bootstrap`_