📖 DOC: #180

starter.ini

@@ -3,12 +3,15 @@
 # Configuration for gitpod to build your stack as you like it
 # Note: Boolean values should always be set to 1 (true) or 0 (false)
 # Note: Version numbers for node packages support semantic versioning or can be left blank
-# Note: Unless in the comments for a section, configuration is
-#   used only the first time a workspace is started and requires a docker image rebuild if changed.
-#   To rebuild the docker image increment the value for INVALIDATE_CACHE in .gitpod.Dockerfile
+# IMPORTANT NOTE: Unless specified in the comments for a section, configuration values are
+# only used first time a workspace is created and not when the workspace is restarted.
+# Furthermore, unless stated otherwise in the comments, any changes made to a value before
+# a workspace is created for the first time requires a rebuild of the Docker image layers
+# To rebuild the Docker image layers, invalidate the docker cache by incrementing the 
+# value for INVALIDATE_CACHE in .gitpod.Dockerfile
 ####################
 
-# Can be changed after a workspace is created
+# [development] values can be changed after a workspace is created
 [development]
 # Valid values: apache, nginx, php
 default_server=nginx
@@ -21,7 +24,7 @@ nginx_log_monitor=tail
 # See https://github.com/apolopena/gitpod-laravel-starter/issues/161
 vscode_disable_preview_tab=1
 
-# Can be changed after a workspace is created
+# [.editorconfig] values can be changed after a workspace is created
 [.editorconfig]
 # valid values are:
 # laravel-default: use the .editorconfig that comes with the laravel project scaffolding
@@ -31,6 +34,8 @@ vscode_disable_preview_tab=1
 # Note: if left blank or set to an invalid value, laravel-default will be used
 type=laravel-js-2space
 
+# Unless specified, if you change values in this section you must increment the 
+# INVALIDATE_CACHE value .gitpod.Dockerfile before the workspace is created.
 [PHP]
 # version, valid values are 7.4 and gitpodlatest.
 # The value 'gitpodlatest' will install the version of php set in
@@ -46,12 +51,14 @@ ppa=OS
 # generate_phpinfo
 # if generate_phpinfo = 1 then a simple pgpinfo.php page will be created in /public
 # if generate_phpinfo = 0 or any other value no action will be taken
+# Does not require a rebuild of the docker image layer when this value is changed.
 generate_phpinfo=1
 
+# Changing values in this section requires a rebuild of the docker image layers
+# Increment the value for INVALIDATE_CACHE in .gitpod.Dockerfile before the workspace is created.
 [phpmyadmin]
 # install, valid values are 0 (do not install) and 1 (install)
 # Requires a docker image to rebuild.
-# To rebuild the docker image increment the value for INVALIDATE_CACHE in .gitpod.Dockerfile
 install=1
 
 [react]