From 4ed536efe3bdf3804806146fb173a8761fae6b30 Mon Sep 17 00:00:00 2001 From: Koen Kanters Date: Fri, 5 Nov 2021 19:35:37 +0100 Subject: [PATCH] WebUI -> Frontend. https://github.com/Koenkk/zigbee2mqtt.io/pull/991 --- docs/devices/E1744.md | 2 +- docs/guide/configuration/README.md | 2 +- docs/guide/configuration/{webui.md => frontend.md} | 2 +- docs/guide/getting-started/README.md | 6 +++--- docs/guide/usage/integrations/home_assistant.md | 2 +- docs/information/frontend.md | 4 ++-- sidebar.ts | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) rename docs/guide/configuration/{webui.md => frontend.md} (99%) diff --git a/docs/devices/E1744.md b/docs/devices/E1744.md index 770a4aba464ba..beced68c67ac1 100644 --- a/docs/devices/E1744.md +++ b/docs/devices/E1744.md @@ -30,7 +30,7 @@ pageClass: device-page Press the button on the device 4 times (until the red light turns on). ### Binding -If you want to [bind](../guide/usage/binding.md) this remote directly to a group or light, bind cluster `LevelCtrl` only (**not** `LevelCtrl` and `OnOff`). If both clusters are bound, a click on the remote toggles the bound group or light twice, thus neither turning it on or off. Cluster-specific binding is most easily done in the [frontend](../guide/configuration/webui.md). +If you want to [bind](../guide/usage/binding.md) this remote directly to a group or light, bind cluster `LevelCtrl` only (**not** `LevelCtrl` and `OnOff`). If both clusters are bound, a click on the remote toggles the bound group or light twice, thus neither turning it on or off. Cluster-specific binding is most easily done in the [frontend](../guide/configuration/frontend.md). ### Legacy integration diff --git a/docs/guide/configuration/README.md b/docs/guide/configuration/README.md index 7566e4e76c326..d76293a057ae0 100755 --- a/docs/guide/configuration/README.md +++ b/docs/guide/configuration/README.md @@ -5,7 +5,7 @@ next: adapter-settings.md # Configuration Zigbee2MQTT is configured using [YAML](https://en.wikipedia.org/wiki/YAML) based `configuration.yml` file. -The file have to be located in the `data` directory within your installation. The `data` directory and the `configuration.yml` has to be writeable for Zigbee2MQTT process because it can get updated - e.g. if you change the settings in the WebUI. It's possible specify a custom data directory by setting the `ZIGBEE2MQTT_DATA` environment variable. +The file have to be located in the `data` directory within your installation. The `data` directory and the `configuration.yml` has to be writeable for Zigbee2MQTT process because it can get updated - e.g. if you change the settings in the frontend. It's possible specify a custom data directory by setting the `ZIGBEE2MQTT_DATA` environment variable. ```yaml # Minimal configuration.yml example diff --git a/docs/guide/configuration/webui.md b/docs/guide/configuration/frontend.md similarity index 99% rename from docs/guide/configuration/webui.md rename to docs/guide/configuration/frontend.md index 33e126bb39065..3ca5df47bef9a 100644 --- a/docs/guide/configuration/webui.md +++ b/docs/guide/configuration/frontend.md @@ -2,7 +2,7 @@ sidebarDepth: 1 --- -# WebUI +# Frontend ::: tip Ongoing discussion about the frontend can be found [here](https://github.com/Koenkk/zigbee2mqtt/issues/4266) ::: diff --git a/docs/guide/getting-started/README.md b/docs/guide/getting-started/README.md index 19147041b5f1f..9b68326b6a1a0 100755 --- a/docs/guide/getting-started/README.md +++ b/docs/guide/getting-started/README.md @@ -100,7 +100,7 @@ mqtt: # Zigbee Adapter path serial: port: /dev/ttyUSB0 -# Enable the Zigbee2MQTT WebUI +# Enable the Zigbee2MQTT frontend frontend: port: 8080 # Let Zigbee2MQTT generate a new network key on first start @@ -123,7 +123,7 @@ $ docker-compose logs -f ``` After some short time you should see some log messages that Mosquitto and Zigbee2MQTT is running now. -You can open the WebUI using [http://localhost:8080](http://localhost:8080) (or the hostname of your remote server). +You can open the frontend using [http://localhost:8080](http://localhost:8080) (or the hostname of your remote server). We can now go on and pair our first device. @@ -134,7 +134,7 @@ Search the [supported devices](../../supported-devices/) for your device and fol If no instructions are available, the device can probably be paired by factory resetting it. -Once you see something similar to below in the log your device is paired and you can start controlling it using the WebUI and MQTT messages. +Once you see something similar to below in the log your device is paired and you can start controlling it using the frontend and MQTT messages. ``` Zigbee2MQTT:info 2019-11-09T12:19:56: Successfully interviewed '0x00158d0001dc126a', device has successfully been paired diff --git a/docs/guide/usage/integrations/home_assistant.md b/docs/guide/usage/integrations/home_assistant.md index 45a39649d8515..67f92c8762bee 100755 --- a/docs/guide/usage/integrations/home_assistant.md +++ b/docs/guide/usage/integrations/home_assistant.md @@ -15,7 +15,7 @@ To achieve the best possible integration (including MQTT discovery): ## Device/group page Since Home Assistant 2021.11 the device/group page in Home Assistant can directly link to the frontend (*Visit device* button). -To enable this set the `url` in the [WebUI](../../configuration/webui.md) configuration. +To enable this set the `url` in the [frontend](../../configuration/frontend.md) configuration. ## Home Assistant device registry When using Home Assistant MQTT discovery, Zigbee2MQTT integrates diff --git a/docs/information/frontend.md b/docs/information/frontend.md index 381e1fdafb935..bd125d80bc1ac 100644 --- a/docs/information/frontend.md +++ b/docs/information/frontend.md @@ -2,8 +2,8 @@ head: - - meta - http-equiv: refresh - content: 0; URL=https://www.zigbee2mqtt.io/guide/configuration/webui.html + content: 0; URL=https://www.zigbee2mqtt.io/guide/configuration/frontend.html - - link - rel: canonical - href: https://www.zigbee2mqtt.io/guide/configuration/webui.html + href: https://www.zigbee2mqtt.io/guide/configuration/frontend.html --- diff --git a/sidebar.ts b/sidebar.ts index b0c6471427834..b7b620f1d3931 100644 --- a/sidebar.ts +++ b/sidebar.ts @@ -26,7 +26,7 @@ export const sidebar: SidebarConfig = { '/guide/configuration/adapter-settings.md', '/guide/configuration/mqtt.md', '/guide/configuration/zigbee-network.md', - '/guide/configuration/webui.md', + '/guide/configuration/frontend.md', '/guide/configuration/devices-groups.md', '/guide/configuration/logging.md', '/guide/configuration/block-pass-list.md',