Skip to content

Commit

Permalink
docs: apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Tom Herbers <[email protected]>
  • Loading branch information
maurerle and herbetom committed Aug 7, 2024
1 parent 1fd073a commit 43a880e
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/features/tls.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/features/wlan-configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/package/gluon-web-cellular.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/package/gluon-web-network.rst
Original file line number Diff line number Diff line change
@@ -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`.

Expand Down

0 comments on commit 43a880e

Please sign in to comment.