Instructions regarding settings.local.php seem to be missing from logical places both in the User Guide and the Community Docs. I got some pointers on drupal.stackexchange.com that helped redirect me.

Some of the platform-specific pages in the local-server-setup section of the guide mention the file, but (I believe the following should be rectified - am I understanding correctly?)
- the description of settings.local.php is not included for each platform
- the use of settings.local.php in place of settings.php should not be a platform-specific concern
- an actual prompt to adopt the practice for local dev appears to be missing regarding using settings.local.php in place of settings.php

For reference, the Unix instructions within the Linux section seem to have the most info on settings.local.php. The MacOS section does not mention it at all.

Am I overlooking docs that already exist, or can I assist with adding them? It would seem logical to add basics to the "local" section of Before a Drupal 8 installation.

Comments

lacuna created an issue. See original summary.

kay_v’s picture

kay_v commented

From my perspective this improvement looks important to work on. I'm not in the loop on how final decisions about changes are made, but I believe a good next step would be to write the improvements you believe fit the requirement, and then submit them as a patch for review.

Looks like there's a related (postponed) issue that I just now linked to this issue, fyi.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Project: User Guide » Documentation
Version: 8.x-6.x-dev »
Component: User Guide content » Correction/Clarification

This issue seems to be mostly relevant for the Community Documentation, not the User Guide? The User Guide is aimed at the complete beginner, and doesn't cover everything... to me, local.settings.php seems like a more advanced topic that we don't need to cover in the User Guide.

So, I'm at least temporarily moving this over to the Community Documentation issue queue, since it is mostly about the Community Documentation -- none of the links in the summary seem to be part of the User Guide. If we need to make changes to both the Community Documentation and the User Guide, we need another issue that points out which pages in the User Guide need updates.

You should generally feel free to edit Community Documentation pages to improve them, by the way. Thanks!

marcvangend’s picture

marcvangend
he/him
Primary language Dutch
Location Amsterdam
commented

Did this ever lead to new or updated documentation? I couldn't find it.