platformsh-templates / drupal10

Drupal 10 (Composer) template for Platform.sh
15 stars 13 forks source link

Possibly move `config_sync_directory` from settings.php to platformsh.settings.php #142

Closed gilzow closed 3 months ago

gilzow commented 3 months ago

Describe the bug

If someone brings their own drupal project, and follows our Drupal Guide (see issue 4073 in the docs), it includes the platformsh.settings.php file from this template and instructs users to add it to their project. HOWEVER, the template's platformsh.settings.php file assumes that

$settings['config_sync_directory'] = '../config/sync';

has already been set in the settings.php file (which is included the template's version but isn't necessarily in a user's code base). Seeing as how this a required setting (the web installer fails if the above setting isn't set when the installer tries to write to the settings.php file), should we move that setting from settings.php into platformsh.settings.php?

Include some logs

N/A

Reproducing

  1. Create a d10 recommended project from scratch.
  2. follow our drupal 10 guide that uses the template's platformsh.settings.php file
  3. try to install drupal via the web GUI installer

Expected behavior

n/a

Your environment

n/a

Screenshots

No response

Additional context

If we decide there are reasons to not move the configuration setting into the platformsh.settings.php file, then we'll need to update the drupal guide to include adding this setting into their settings.php file.

gilzow commented 3 months ago

It's been decided to go ahead and move the config setting into the platformsh.settings.php file so it's all self-contained. PR incoming