From 58b547e3b6f937fc1268f433b30a5336790c7cb2 Mon Sep 17 00:00:00 2001 From: Vanessa Maegima Date: Mon, 5 Feb 2024 13:06:22 -0300 Subject: [PATCH] lifecycle: introduce customer lifecycle guide Signed-off-by: Vanessa Maegima --- source/index.rst | 12 +++++++ source/lifecycle/development.rst | 48 +++++++++++++++++++++++++ source/lifecycle/lifecycle-overview.rst | 13 +++++++ source/lifecycle/onboarding.rst | 29 +++++++++++++++ source/lifecycle/production.rst | 4 +++ source/lifecycle/testing-tooling.rst | 12 +++++++ 6 files changed, 118 insertions(+) create mode 100644 source/lifecycle/development.rst create mode 100644 source/lifecycle/lifecycle-overview.rst create mode 100644 source/lifecycle/onboarding.rst create mode 100644 source/lifecycle/production.rst create mode 100644 source/lifecycle/testing-tooling.rst diff --git a/source/index.rst b/source/index.rst index b2016f25..303de28c 100644 --- a/source/index.rst +++ b/source/index.rst @@ -31,6 +31,18 @@ OE/Yocto Project, the Linux microPlatform™ and Docker®. tutorials/customizing-the-platform/customizing-the-platform tutorials/working-with-tags/working-with-tags +.. toctree:: + :maxdepth: 1 + :glob: + :caption: Life Cycle / Customer Journey / Good Name Here + :name: sec-lifecycle + + lifecycle/lifecycle-overview + lifecycle/onboarding + lifecycle/development + lifecycle/testing-tooling + lifecycle/production + .. toctree:: :maxdepth: 1 :glob: diff --git a/source/lifecycle/development.rst b/source/lifecycle/development.rst new file mode 100644 index 00000000..ac946459 --- /dev/null +++ b/source/lifecycle/development.rst @@ -0,0 +1,48 @@ +Development +=========== + +DevOps +------ + +.. toctree:: + :maxdepth: 1 + + ../reference-manual/remote-access/remote-access + ../user-guide/foundriesio-rest-api/foundriesio-rest-api + +Application Developer +--------------------- + +.. toctree:: + :maxdepth: 1 + + ../user-guide/containers-and-docker/index + ../reference-manual/docker/private-registries + +Embedded Developer +------------------ + +.. toctree:: + :maxdepth: 1 + + ../user-guide/lmp-customization/index + ../user-guide/lmp-auto-hostname/lmp-auto-hostname + ../user-guide/lmp-device-auto-register/lmp-device-auto-register + ../user-guide/custom-sota-client + ../user-guide/offline-update/offline-update + ../porting-guide/pg + ../reference-manual/linux/linux-disk-encryption + ../reference-manual/linux/factory-device-reset + ../reference-manual/linux/linux-update + +Embedded Developer & SecOps +--------------------------- + +.. toctree:: + :maxdepth: 1 + + ../reference-manual/security/secure-machines + ../reference-manual/security/offline-keys + ../reference-manual/security/factory-keys + ../reference-manual/factory/sboms + ../user-guide/el2g diff --git a/source/lifecycle/lifecycle-overview.rst b/source/lifecycle/lifecycle-overview.rst new file mode 100644 index 00000000..c2993f4b --- /dev/null +++ b/source/lifecycle/lifecycle-overview.rst @@ -0,0 +1,13 @@ +Life Cycle Overview +=================== + +**EXAMPLE - DRAFT** + +This presents a doc view based on life cycle, where + +- onboarding: ... +- development: ... +- testing and tooling: ... +- production: ... + +This helps to guide the customer in a better development journey. diff --git a/source/lifecycle/onboarding.rst b/source/lifecycle/onboarding.rst new file mode 100644 index 00000000..453e6567 --- /dev/null +++ b/source/lifecycle/onboarding.rst @@ -0,0 +1,29 @@ +Onboarding +========== + +Prologue +-------- + +.. toctree:: + :maxdepth: 1 + + ../user-guide/fioctl/index + ../user-guide/qemu/qemu + +Admin & DevOps +-------------- + +.. toctree:: + :maxdepth: 1 + + ../user-guide/account-management/account-management + +DevOps +------ + +.. toctree:: + :maxdepth: 1 + + ../user-guide/custom-ci/custom-ci + ../user-guide/mirror-action/mirror-action + ../user-guide/submodule/submodule diff --git a/source/lifecycle/production.rst b/source/lifecycle/production.rst new file mode 100644 index 00000000..6a7a8069 --- /dev/null +++ b/source/lifecycle/production.rst @@ -0,0 +1,4 @@ +Production +========== + +TODO: This can cover "Go to Production checklist", "Keys Maintenance Specs". diff --git a/source/lifecycle/testing-tooling.rst b/source/lifecycle/testing-tooling.rst new file mode 100644 index 00000000..e17a27be --- /dev/null +++ b/source/lifecycle/testing-tooling.rst @@ -0,0 +1,12 @@ +Testing and Tooling +=================== + +SecOps +------ + +.. toctree:: + :maxdepth: 1 + + ../reference-manual/ota/production-targets + ../user-guide/device-gateway-pki/device-gateway-pki + ../user-guide/rotating-cert