From 6bf82e9c656a73e0464b57fe99acb7eb24010372 Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Tue, 16 Feb 2021 16:32:34 +0100 Subject: [PATCH] [welcome] Update .conf documentation - fix typo - don't suggest google as internetCheckUrl - mark TODOs for #1384 --- src/modules/welcome/welcome.conf | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/src/modules/welcome/welcome.conf b/src/modules/welcome/welcome.conf index bd15a6f2d..b3da8d366 100644 --- a/src/modules/welcome/welcome.conf +++ b/src/modules/welcome/welcome.conf @@ -10,14 +10,19 @@ # can check requirements for installation. --- # Display settings for various buttons on the welcome page. -# The URLs themselves come from branding.desc is the setting -# here is "true". If the setting is false, the button is hidden. +# The URLs themselves come from `branding.desc`. Each button +# is show if the corresponding *show* setting +# here is "true". If the setting is "false", the button is hidden. +# Empty or not-set is interpreted as "false". +# +# TODO:3.3 Remove the URL fallback here; URLs only in `branding.desc` +# # The setting can also be a full URL which will then be used -# instead of the one from the branding file, or empty or not-set -# which will hide the button. +# instead of the one from the branding file. showSupportUrl: true showKnownIssuesUrl: true showReleaseNotesUrl: false +# TODO:3.3 Move to branding, keep only a bool here showDonateUrl: https://kde.org/community/donations/ # Requirements checking. These are general, generic, things @@ -26,7 +31,7 @@ showDonateUrl: https://kde.org/community/donations/ requirements: # Amount of available disk, in GiB. Floating-point is allowed here. # Note that this does not account for *usable* disk, so it is possible - # to pass this requirement, yet have no space to install to. + # to satisfy this requirement, yet have no space to install to. requiredStorage: 5.5 # Amount of available RAM, in GiB. Floating-point is allowed here. @@ -34,7 +39,10 @@ requirements: # To check for internet connectivity, Calamares does a HTTP GET # on this URL; on success (e.g. HTTP code 200) internet is OK. - internetCheckUrl: http://google.com + # Use a privacy-respecting URL here, preferably in your distro's domain. + # + # The URL is only used if "internet" is in the *check* list below. + internetCheckUrl: http://example.com # List conditions to check. Each listed condition will be # probed in some way, and yields true or false according to