From edad24fafebc9200fa6a61a3d3206cbec304ceb0 Mon Sep 17 00:00:00 2001 From: ruben Date: Fri, 4 Dec 2015 10:01:47 +0100 Subject: [PATCH] docs: enhanced site.conf wording --- docs/user/site.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/user/site.rst b/docs/user/site.rst index a98c6ff3..77cafbd2 100644 --- a/docs/user/site.rst +++ b/docs/user/site.rst @@ -12,7 +12,9 @@ Configuration The ``site.conf`` is a lua dictionary with the following defined keys. hostname_prefix - A string which shall prefix the default hostname of a device. + An optional string which would prefix the generated default hostname of a device. + If you want to force the user to think about a unique name enter an invalid prefix + with spaces like 'Enter a name for your node' site_name The name of your community. @@ -252,7 +254,8 @@ roles : optional setup_mode : package Allows skipping setup mode (config mode) at first boot when attribute - ``skip`` is set to ``true``. This is optional and may be left out. + ``skip`` is set to ``true``. This is optional and may be left out. If set to `true`, + make sure that you enter a valid `hostname_prefix`. :: setup_mode = {