From aa10af6dca9b7076a4ce8829f7d99e9354f6722d Mon Sep 17 00:00:00 2001
From: Andrei Gherzan <andrei.gherzan@huawei.com>
Date: Wed, 7 Apr 2021 13:58:29 +0100
Subject: [PATCH] docs: Rename demos as blueprints
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
---
.../assets/smart-home-blueprint-arch.png} | Bin
.../assets/smart-home-blueprint-arch.puml} | 4 +--
docs/blueprints/index.rst | 14 ++++++++++
docs/{demos => blueprints}/smart-panel.rst | 25 +++++++++---------
docs/demos/index.rst | 14 ----------
docs/index.rst | 2 +-
6 files changed, 30 insertions(+), 29 deletions(-)
rename docs/{demos/assets/smart-home-demo-arch.png => blueprints/assets/smart-home-blueprint-arch.png} (100%)
rename docs/{demos/assets/smart-home-demo-arch.puml => blueprints/assets/smart-home-blueprint-arch.puml} (91%)
create mode 100644 docs/blueprints/index.rst
rename docs/{demos => blueprints}/smart-panel.rst (64%)
delete mode 100644 docs/demos/index.rst
diff --git a/docs/demos/assets/smart-home-demo-arch.png b/docs/blueprints/assets/smart-home-blueprint-arch.png
similarity index 100%
rename from docs/demos/assets/smart-home-demo-arch.png
rename to docs/blueprints/assets/smart-home-blueprint-arch.png
diff --git a/docs/demos/assets/smart-home-demo-arch.puml b/docs/blueprints/assets/smart-home-blueprint-arch.puml
similarity index 91%
rename from docs/demos/assets/smart-home-demo-arch.puml
rename to docs/blueprints/assets/smart-home-blueprint-arch.puml
index 82c71a61..3e2dde82 100644
--- a/docs/demos/assets/smart-home-demo-arch.puml
+++ b/docs/blueprints/assets/smart-home-blueprint-arch.puml
@@ -2,12 +2,12 @@
'
' SPDX-License-Identifier: CC-BY-4.0
-@startuml smarthome-demo-arch
+@startuml smarthome-blueprint-arch
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
HIDE_STEREOTYPE()
-title SmartHome demo architecture
+title SmartHome Blueprint Architecture
Person(user, "User")
System(dashboard, "Dashboard", "Home Assistant software running on Avenger96 board, interfacing with the user via a touchscreen")
diff --git a/docs/blueprints/index.rst b/docs/blueprints/index.rst
new file mode 100644
index 00000000..9b2cf946
--- /dev/null
+++ b/docs/blueprints/index.rst
@@ -0,0 +1,14 @@
+.. SPDX-FileCopyrightText: Huawei Inc.
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+OpenHarmony Blueprints
+######################
+
+This section details the available blueprints provided as part of the
+OpenHarmony environment.
+
+.. toctree::
+ :maxdepth: 1
+
+ smart-panel
diff --git a/docs/demos/smart-panel.rst b/docs/blueprints/smart-panel.rst
similarity index 64%
rename from docs/demos/smart-panel.rst
rename to docs/blueprints/smart-panel.rst
index 81858728..eefd8fb5 100644
--- a/docs/demos/smart-panel.rst
+++ b/docs/blueprints/smart-panel.rst
@@ -2,8 +2,8 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-Smart Panel Demo
-################
+Smart Panel Blueprint
+#####################
.. contents::
:depth: 3
@@ -11,16 +11,17 @@ Smart Panel Demo
Overview
********
-The Smart Panel Demo provides support for building a PoC for a home automation
-system with components showing the capabilities of the build infrastructure in
-leveraging different kernels for building an end to end solution.
+The Smart Panel Blueprint provides support for building a PoC for a home
+automation system with components showing the capabilities of the build
+infrastructure in leveraging different kernels for building an end to end
+solution.
The setup is composed of an Avenger96 board acting as a gateway and running
HomeAssistant. The gateway also provides UI as a browser connected to the
localhost HomeAssistant server. The gateway is connected over Bluetooth to two
Nitrogen boards exposing sensors and/or emulating device (e.g. light bulbs).
-.. image:: assets/smart-home-demo-arch.png
+.. image:: assets/smart-home-blueprint-arch.png
How to build
************
@@ -29,20 +30,20 @@ The Linux Gateway
-----------------
1. Refer to :ref:`Building OHOS image for Avenger96 <SupportedBoardAvenger96>` to learn how to set up a build environment, build and flash a base OpenHarmony Linux image.
-2. Build demo image by invoking following bitbake command
+2. Build blueprint image by invoking following bitbake command
.. code-block:: console
- $ MACHINE=stm32mp1-av96 DISTRO=openharmony-linux-demo-dashboard bitbake demo-dashboard-gateway-image
+ $ MACHINE=stm32mp1-av96 DISTRO=openharmony-linux-blueprint-dashboard bitbake blueprint-dashboard-gateway-image
IOT Endpoints
-------------
1. Connect Sensors Mezzanine adapter to each Nitrogen board. Connect I/O devices
- according to SmartHome Demo app `README <https://git.ostc-eu.org/OSTC/OHOS/components/smart_home_demo_zephyr/-/blob/develop/README.md#connections>`_
+ according to SmartHome Blueprint app `README <https://git.ostc-eu.org/OSTC/OHOS/components/smart_home_demo_zephyr/-/blob/develop/README.md#connections>`_
2. Refer to :ref:`Working with the board <SupportedBoardNitrogen>` to learn how to set up a build environment, build and flash a sample Zephyr application.
3. Connect target board to the PC using USB connector.
-4. Build and flash demo image by invoking one of the following bitbake commands (for each IOT endpoint type respectively)
+4. Build and flash blueprint image by invoking one of the following bitbake commands (for each IOT endpoint type respectively)
.. note:: In order to connect multiple and flash selected boards, please refer to
`meta-zephyr README <http://git.yoctoproject.org/cgit/cgit.cgi/meta-zephyr/plain/README.txt>`_
@@ -54,7 +55,7 @@ IOT Endpoints
.. code-block:: console
- $ MACHINE=96b-nitrogen DISTRO=openharmony-zephyr bitbake zephyr-demo-smarthome-sensors -c flash_usb
+ $ MACHINE=96b-nitrogen DISTRO=openharmony-zephyr bitbake zephyr-blueprint-smarthome-sensors -c flash_usb
**For bulb/LED board:**
@@ -62,5 +63,5 @@ IOT Endpoints
.. code-block:: console
- $ MACHINE=96b-nitrogen DISTRO=openharmony-zephyr bitbake zephyr-demo-smarthome-led -c flash_usb
+ $ MACHINE=96b-nitrogen DISTRO=openharmony-zephyr bitbake zephyr-blueprint-smarthome-led -c flash_usb
diff --git a/docs/demos/index.rst b/docs/demos/index.rst
deleted file mode 100644
index c8edfbd6..00000000
--- a/docs/demos/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-.. SPDX-FileCopyrightText: Huawei Inc.
-..
-.. SPDX-License-Identifier: CC-BY-4.0
-
-OpenHarmony Demos
-#################
-
-This section details the available demos provided as part of the OpenHarmony
-environment.
-
-.. toctree::
- :maxdepth: 1
-
- smart-panel
diff --git a/docs/index.rst b/docs/index.rst
index d94c0175..f3a72a23 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,5 +13,5 @@ Build system documentation
repo-workspace
build-flavours/index
ohos-build/index
- demos/index
+ blueprints/index
hardware-support/index
--
GitLab