Browse Source

docs: feature/roles: update outdates site config docs

Matthias Schiffer 7 years ago
parent
commit
3fd0ca77c7
2 changed files with 13 additions and 9 deletions
  1. 10 6
      docs/features/roles.rst
  2. 3 3
      docs/user/site.rst

+ 10 - 6
docs/features/roles.rst

@@ -2,7 +2,7 @@ Roles
 =====
 
 It is possible to define a set of roles you want to distinguish at backend side. One node can own one
-role which it will announce via alfred inside the mesh. This will make it easier to differentiate 
+role which it will announce via alfred inside the mesh. This will make it easier to differentiate
 nodes when parsing alfred data. E.g to count only **normal** nodes and not the gateways
 or servers (nodemap). A lot of things are possible.
 
@@ -11,17 +11,21 @@ For this the section ``roles`` in ``site.conf`` is needed::
   roles = {
     default = 'node',
     list = {
-      node = 'Normal Node',
-      test = 'Test Node',
-      backbone = 'Backbone Node',
-      service = 'Service Node',
+      'node',
+      'test',
+      'backbone',
+      'service',
     },
   },
 
+The strings to display in the LuCI interface are configured per language in the
+``i18n/en.po``, ``i18n/de.po``, etc. files of the site repository using message IDs like
+``gluon-luci-node-role:role:node`` and ``gluon-luci-node-role:role:backbone``.
+
 The value of ``default`` is the role every node will initially own. This value should be part of ``list`` as well.
 If you want node owners to change the defined roles via config-mode you can add the package
 ``gluon-luci-node-role`` to your ``site.mk``. Then, you can select one of the defined roles from a dropdown list
-where the right-handed value is the one which is displayed and the left-handed key the one which is configured into 
+where the right-handed value is the one which is displayed and the left-handed key the one which is configured into
 the system.
 
 The role is saved in ``gluon-node-info.system.role``. To change the role using command line do::

+ 3 - 3
docs/user/site.rst

@@ -183,7 +183,7 @@ fastd_mesh_vpn
     In any case, the ``null`` method should always be the first method in the list
     if it is supported at all. You should only set `configurable` to `true` if the
     configured peers support both the ``null`` method and methods with encryption.
-    
+
     You can set syslog_level from verbose (default) to warn to reduce syslog output.
     ::
 
@@ -286,7 +286,7 @@ roles \: optional
     part of ``list``. If you want node owners to change the role via config mode add
     the package ``gluon-luci-node-role`` to ``site.mk``.
 
-    The strings to display in the LuCI interface can be configured per language in the
+    The strings to display in the LuCI interface are configured per language in the
     ``i18n/en.po``, ``i18n/de.po``, etc. files of the site repository using message IDs like
     ``gluon-luci-node-role:role:node`` and ``gluon-luci-node-role:role:backbone``.
     ::
@@ -366,7 +366,7 @@ gluon-config-mode:pubkey
 
 gluon-config-mode:altitude-label
     Label for the ``altitude`` field
-    
+
 gluon-config-mode:altitude-help
     Description for the usage of the ``altitude`` field