From 43a880e4b07500fb58b5f9f2cc2055f213b44293 Mon Sep 17 00:00:00 2001 From: Florian Maurer <f.maurer@outlook.de> Date: Thu, 28 Mar 2024 15:15:04 +0100 Subject: [PATCH] docs: apply suggestions from code review Co-authored-by: Tom Herbers <github@herbetom.de> --- docs/features/tls.rst | 2 +- docs/features/wlan-configuration.rst | 2 +- docs/package/gluon-web-cellular.rst | 4 ++-- docs/package/gluon-web-network.rst | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/features/tls.rst b/docs/features/tls.rst index 1c199091a..d6b2a396a 100644 --- a/docs/features/tls.rst +++ b/docs/features/tls.rst @@ -4,7 +4,7 @@ TLS support The generic TLS implementation which is currently used by OpenWRT can be installed or added as dependency through the package ``gluon-tls``. This removes the need for community packages to depend on a specific TLS implementation (like mbedtls, OpenSSL or WolfSSL). -This package is a placeholder for the current TLS implementation used. +This package is an alias for the current TLS implementation used. To allow for easy usage of communicating through HTTPS from the node, typical Certificate Authorities (CAs) are included through the package ``ca-bundle`` . * Starting with OpenWRT 23.05, mbedtls is the default TLS layer - this is reflected in Gluon :ref:`v2023.2 <releases-v2023.2-minor-changes>`. HTTPS is used by default to communicate with OpenWRT opkg servers. diff --git a/docs/features/wlan-configuration.rst b/docs/features/wlan-configuration.rst index f0c30ea0b..4d6988355 100644 --- a/docs/features/wlan-configuration.rst +++ b/docs/features/wlan-configuration.rst @@ -9,7 +9,7 @@ configuration. Outdoor mode ------------ -Configuring the node for `outdoor use` tunes the 5 GHz radio to a frequency and transmission power that conforms with the local regulatory requirements. +Configuring the node for outdoor use tunes the 5 GHz radio to a frequency and transmission power that conforms with the local regulatory requirements. It also enables dynamic frequency selection (DFS; radar detection). At the same time, mesh functionality is disabled as it requires neighbouring nodes to stay on the same channel permanently. diff --git a/docs/package/gluon-web-cellular.rst b/docs/package/gluon-web-cellular.rst index bfd0013bf..3165a4022 100644 --- a/docs/package/gluon-web-cellular.rst +++ b/docs/package/gluon-web-cellular.rst @@ -3,12 +3,12 @@ gluon-web-cellular ================== -This package allows the configure WWAN for capable cellular devices. +This package allows to configure WWAN for capable cellular devices. This works by creating an abstraction layer into Gluon which takes common options (SIM PIN / APN) and translates it to modem-specific settings based on the specific device using. Doing so limits the use-case onto specific models (no LTE sticks possible) but provides a common interface. -The WWAN is assigned the firewall WAN zone and wired WAN can still be used, however without prioritization. +The WWAN is assigned the WAN firewall zone and wired WAN can still be used, however without prioritization. The traffic path is not configured to prefer one uplink source or the other. .. image:: gluon-web-cellular.png diff --git a/docs/package/gluon-web-network.rst b/docs/package/gluon-web-network.rst index 5de4359f4..05625e2c0 100644 --- a/docs/package/gluon-web-network.rst +++ b/docs/package/gluon-web-network.rst @@ -1,8 +1,8 @@ gluon-web-network ================= -The package *gluon-web-network* is part of the :ref:`Feature Flag <user-site-feature-flags>` web-advanced. -It allows to configure the roles of the gluon nodes network interfaces in config mode through checkboxes. +The package *gluon-web-network* is part of :ref:`Feature Flag <user-site-feature-flags>` web-advanced. +It allows to configure the network interfaces roles of the gluon node in config mode through checkboxes. It is a user-friendly way to configure what otherwise would need the :ref:`wired-mesh-commandline`. -- GitLab