Merge branch 'desktop_documentation' into 'master'

Update to Desktop Documentation

See merge request linux-infra/documentation!20

_toc.yml

@@ -90,6 +90,7 @@ chapters:
               - file: admin-guide/configuration/files/sftp_server
           - file: admin-guide/configuration/desktop
             sections:
+              - file: admin-guide/configuration/desktop/desktop
               - file: admin-guide/configuration/desktop/gnome
               - file: admin-guide/configuration/desktop/keyboard_layout
               - file: admin-guide/configuration/desktop/xrdp

admin-guide/configuration/desktop/alternative_desktops.md

@@ -4,11 +4,11 @@ Per default Gnome is installed, but sometimes there is the wish for other Deskto
 When changing the default desktop, please check the last chapter "Reset User Default Desktop".
 
 ## XFCE
-XFCE is installed when `base::enable_xfce: true` is set in Hiera.
+XFCE is installed when `desktop::enable_xfce: true` is set in Hiera.
 It then is also used by default with `base::xfce_default: true` or `desktop::session_manager: xfce`.
 
 ## IceWM
-IceWM is installed when `base::enable_icewm: true` is set in Hiera.
+IceWM is installed when `desktop::enable_icewm: true` is set in Hiera.
 It then is also used by default with `desktop::session_manager: icewm-session`.
 
 ## Other (e.g. KDE)

admin-guide/configuration/desktop/banner_message.md

@@ -1,9 +1,9 @@
 # Banner Message
 
-To show a specific message on the Desktop login screen, use the Hiera key `desktop::banner_message`:
+To show a specific message on the Desktop login screen, use the Hiera key `gdm::banner_message`:
 
 ```
-desktop::banner_message: 'Good morning, this is a test banner message!'
+gdm::banner_message: 'Good morning, this is a test banner message!'
 ```
 
 Which then looks on RHEL8 like
@@ -15,7 +15,4 @@ The default is
 Please contact the service desk (phone: 4800) in case you have problems logging in.
 ```
 
-This is only implemented for `gdm` (default) and not yet for `lightdm` (rarely used at PSI)
-
-
-
+As the key suggests this is only implemented for `gdm` (default).

admin-guide/configuration/desktop/desktop.md

@@ -0,0 +1,38 @@
+# Enabling Desktop Environment
+
+A desktop/graphical interface can be enabled on any kind of systems (regardless of puppet role). This can be done as follows:
+
+```yaml
+base::enable_desktop: true
+```
+
+By default this will install and enable Gnome as desktop and gdm as Display Manager. Without this setting the further options do not have any effect!
+
+The desktop configuration can be further refined and/or adapted by following keys:
+
+```yaml
+desktop::display_manager: gdm  # available options: gdm (default), lightdm
+
+# this will set the default session manager, however other avaiable options can still be selected at login time
+desktop::session_manager: gnome-xorg # availale options: gnome-xorg (default), gnome-classic, xfce, ...
+```
+
+Individual desktops can be enabled/disabled via:
+```yaml
+desktop::enable_gnome: true # true (default)
+desktop::enable_xfce: true # false (default)
+desktop::enable_icewm: true # false (default)
+```
+
+When enabling a desktop environment also the installation of desktop apps will automatically take place (including firefox, etc.). If you prefer a slim setup you can disable this by:
+
+```yaml
+desktop::enable_office_apps: false # default: true
+```
+
+Further refinements can be done as documented in the other guides in this section.
+
+Finally here a rough overview of the destop_profile structure:
+![Structure desktop profile](_static/desktop_profile.svg)
+[Structure desktop_profile](_static/desktop_profile.excalidraw)
+

engineering-guide/puppet/profiles/gnome.rst

@@ -1,46 +0,0 @@
-``profile::gnome``
-==================
-
-This module installs and configures the Gnome desktop environment.
-
-
-Parameters
-----------
-
-===============================  ========  ================================================
-**Name**                         **Type**  **Default**
--------------------------------  --------  ------------------------------------------------
-banner_message                   string
-enable_update_notifications      bool
-favorites                        list
-keyboard_layouts                 list
-===============================  ========  ================================================
-
-
-``banner_message``
-~~~~~~~~~~~~~~~~~~
-
-The message displayed above the login prompt.
-
-
-``enable_update_notifications``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Whether or not ``gnome-software`` is started at the beginning of a session to
-notify the user about available updates.
-
-
-``favorites``
-~~~~~~~~~~~~~
-
-The applications/directories/etc to be displayed in the *Favorites* menu and/or
-the Gnome dock. Each member of the list must be a string containing the full
-name (not path!) of the ``.desktop`` file, eg. ``gnome-terminal.desktop`` for
-the Gnome Terminal.
-
-
-``keyboard_layouts``
-~~~~~~~~~~~~~~~~~~~~
-
-A list of the keyboard mappings which should be available on the login screen.
-The first mapping in the list is the default.