diff --git a/requirements/governance.md b/requirements/governance.md index d14ddd905..da7d64978 100644 --- a/requirements/governance.md +++ b/requirements/governance.md @@ -266,129 +266,8 @@ repository, and not along side of the code that is implementing them. The Requirements Repository **MUST** be located at: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - [https://github.com/rdkcentral/firebolt-apis](https://github.com/rdkcentral/firebolt-apis) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ### 4.10. Requirements Repository Branching The Requirements Repository **MUST** have the following branches: @@ -398,13 +277,13 @@ The Requirements Repository **MUST** have the following branches: | next | For all approved specifications, even those that have not been released under a version. | | proposed | An experimental branch containing all proposed specifications. | - Working Drafts and Candidate Specification Drafts **MUST** be housed in a named feature branch in the Requirements Repository (see below). Branches are merged based on the approval process: ![Branching](./images/governance/branching.png) + ### 4.11. Sanctioned Forks From time to time an organization with access to the Requirements Repository @@ -426,6 +305,7 @@ approved APIs, which may be different than the API in the fork. The Advisory Board, and selected Working Group, **SHOULD** be willing to avoid unnecessary changes to make migration as easy as possible, without sacrificing the integrity of the Firebolt Open-Source Project’s goals. + ### 4.12. Release Versions The Advisory Board has ownership of when to do major, minor, and patch releases diff --git a/requirements/specifications/lifecycle/index.md b/requirements/specifications/lifecycle/index.md index a5c5ed793..dd66c9742 100644 --- a/requirements/specifications/lifecycle/index.md +++ b/requirements/specifications/lifecycle/index.md @@ -19,7 +19,6 @@ See [Firebolt Requirements Governance](../../governance.md) for more info. ## 1. Overview - This document describes the requirements that Firebolt platforms and Firebolt applications must fulfill when managing App Lifecycles. *App Lifecycle* refers to the lifecycle of an individual app from the time it is @@ -101,26 +100,7 @@ transition methods, see [Transitions](#4-lifecycle-state-transitions), for more on this. ![Lifecycle States](../../images/specifications/lifecycle/lifecycle-states.png) - - - - - - - - - - - - - - - - - - - | | CPU | RAM | F/S | Net | GFX | SFC | A/V | Description | |--------------|-----|-----|-----|-----|-----|-----|-----|----------------------------------------------------------------------------| | Initializing | ✔ | ✔ | ✔ | ✔ | | | | Started executing, but is not yet instantiated as a Firebolt app. | diff --git a/requirements/specifications/lifecycle/presentation.md b/requirements/specifications/lifecycle/presentation.md index 209dd1a81..7ba84f5ce 100644 --- a/requirements/specifications/lifecycle/presentation.md +++ b/requirements/specifications/lifecycle/presentation.md @@ -41,6 +41,7 @@ whether or not the app has input, e.g. RCU, focus. **TODO**: let's clearly define focus. RCU, soft-keyboard, soft-remote, As a property, this API also has an `onFocusChanged` notification. + ## 3. Display The `Presentation` module **MUST** have a `display` string property that @@ -55,9 +56,9 @@ returns one of the following values: | `loading` | The platform is displaying a loading screen while the app prepares to be activated | | `none` | The app does not have it's graphics surface attached to the screen | - **TODO**: an app could be offscreen & scaled. If a scaled or thumbnailed app goes offscreen, it's now offscreen. + ### 3.1. Display vs Lifecycle Each Lifecycle state only supports certain display states: