platformsh
Drupal guide changes
Where on docs.platform.sh should be changed?
https://docs.platform.sh/guides/drupal/deploy/configure.html https://docs.platform.sh/guides/drupal/deploy/customize.html
What exactly should be updated?
In the configure section of the Drupal guide, we include a .platform.app.yaml file for the user to copy. HOWEVER this file comes from our template and assumes there are two additional files present: drush/platformsh_deploy_drush.sh and drush/platformsh_generate_drush_yml.php that a user bringing their own code will not have. We need to either remove the references to these files in the sample .platform.app.yaml file OR add a note that the user will need to copy these files into their project from our D10 repo.
What exactly should be updated?
In the customize section, we include the contents of the settings.platformsh.php file from our template but this file assumes
$settings['config_sync_directory'] = '../config/sync';
has already been added in the settings.php file (and it is in our template). Without this setting being added, the Drupal installation will fail when drupal tries to add the setting into the settings.php file. We need to add a section with this information or add it to the settings.platformsh.php file in the guide and the template.
Additional context
No response
I'll mention that the guide says
In the Drupal template, the settings.php file is mostly replaced with a stub that contains only the most basic configuration and then includes a settings.platformsh.php and settings.local.php file, if they exist.
but we don't necessarily call out that the user's settings.php file must include at least the settings we've added (or again, we move those into our platformsh.settings.php file).
It's been decided to move the config_sync_directory setting into the settings.platformsh.php file. see: https://github.com/platformsh-templates/drupal10/pull/144
However, in the guide we still need to include a step for the user to create the config/sync directory and place a .gitkeep file in it.