Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Bug Documentation is unclear
Normal Functionality not inhibited
Unfrozen changes Documentation changes
Prioritized changes The main goal of this issue is to enhance the clarity of documentation for 8.0.x/7.0.x (note this bug is tagged for backport)
Disruption Change is not disruptive for core/contributed and custom modules/theme and will not require a BC break/deprecation/data model changes/an upgrade path/internal refactoring/widespread changes.

Upgrade.txt has the following:

Sometimes an update includes changes to default.settings.php (this will be
noted in the release notes). If that's the case, follow these steps:

- Make a backup copy of your settings.php file, with a different file name.

- Make a copy of the new default.settings.php file, and name the copy
settings.php (overwriting your previous settings.php file).

- Copy the custom and site-specific entries from the backup you made into the
new settings.php file. You will definitely need the lines giving the
database information, and you will also want to copy in any other
customizations you have added.

It would be better if it read:

Sometimes an update includes changes to default.settings.php (this will be
noted in the release notes). If that's the case, follow these steps:

- Locate your settings.php file in the /sites/default folder.

- Make a backup copy of your settings.php file, with a different file name.

- Make a copy of the new default.settings.php file, and name the copy
settings.php (overwriting your previous settings.php file).

- Copy the custom and site-specific entries from the backup you made into the
new settings.php file. You will definitely need the lines giving the
database information, and you will also want to copy in any other
customizations you have added.

CommentFileSizeAuthor
#22 drupal-mentionlocationofsettingsphp-2507911-22.patch611 bytesnaveenvalecha
#18 interdiff-2507911-9-11.txt620 bytesnaveenvalecha
#18 drupal-mentionlocationofsettingsphp-2507911-11.patch631 bytesnaveenvalecha
#9 interdiff-2507911-5-9.txt480 bytesdylf
#9 drupal-mentionlocationofsettingsphp-2507911-9.patch598 bytesdylf
#5 interdiff-2507911-3-5.txt483 bytesdeepakaryan1988
#5 drupal-mentionlocationofsettingsphp-2507911-5.patch604 bytesdeepakaryan1988
#3 drupal-mentionlocationofsettingsphp-2507911-3.patch601 bytesmikebell_
#2 drupal-mentionlocationofsettingsphp-2507911-2.patch1.3 KBmikebell_

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Version: 7.38 » 8.0.x-dev
Category: Feature request » Task
Issue tags: +Novice, +Needs backport to D7

The settings.php file is not necessarily in the sites/default folder. It could be in a different sites/* folder. Other than that, this seems like an OK thing to do. But we would need to patch 8.x before we do 7.x.

mikebell_’s picture

mikebell_ commented
Status: Active » Needs review
StatusFileSize
new drupal-mentionlocationofsettingsphp-2507911-2.patch1.3 KB

Patch attached

mikebell_’s picture

mikebell_ commented
StatusFileSize
new drupal-mentionlocationofsettingsphp-2507911-3.patch601 bytes

Hastily forgot to make sure that it was correctly indented, this is a much smaller patch.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Thanks for the patches!

As noted above, the settings.php file may not be in that folder though -- see comment #1.

Also I do not think we normally use the word "folder", we usually use "directory" I think? But we should check on that and be consistent with the various other README-type files.

deepakaryan1988’s picture

deepakaryan1988
Primary language Hindi
commented
Status: Needs work » Needs review
StatusFileSize
new drupal-mentionlocationofsettingsphp-2507911-5.patch604 bytes
new interdiff-2507911-3-5.txt483 bytes

Address the point which is in #4

naveenvalecha’s picture

naveenvalecha
He/Him
commented

#4

Also I do not think we normally use the word "folder", we usually use "directory" I think? But we should check on that and be consistent with the various other README-type files.

Right.I have checked in another Readme.txt file in modules folder.RTBC +1
Regarding #1

The settings.php file is not necessarily in the sites/default folder. It could be in a different sites/* folder.

As our current documentation is for single site install. Should we also specify in another extra line about mutisite install settings.php ? and add sites/* Is this documentation is fine ?

Thanks!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Regarding folder vs. directory:
core/INSTALL.txt - uses directory everywhere, no "folder"
core/UPGRADE.txt - same (at least before this patch)
modules/README.txt - same

So yes it should definitely be "directory" not "folder", and thanks for making that change in the latest patch!

But. The latest patch still does not address #1. sites/default is not always the correct location for this file.

dylf’s picture

dylf commented
Assigned: Unassigned » dylf
dylf’s picture

dylf commented
Status: Needs work » Needs review
StatusFileSize
new drupal-mentionlocationofsettingsphp-2507911-9.patch598 bytes
new interdiff-2507911-5-9.txt480 bytes

Addressed #1.

kfitz’s picture

kfitz commented

Changes look good, address the issue of the patch, and stay within the scope of the issue. One detail I noticed is that it may have been possible to only edit the changed line of text and not insert the newline, but the end result is the same. No major changes or functionality are introduced by this patch.

kfitz’s picture

kfitz commented
Issue summary: View changes
kfitz’s picture

kfitz commented
Issue summary: View changes
kfitz’s picture

kfitz commented
Issue summary: View changes
kfitz’s picture

kfitz commented
Issue summary: View changes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community
Issue tags: +Quick fix

Looks good to me, thanks!

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented
Status: Reviewed & tested by the community » Needs review

So while #1 is valid, the fact is that 99.9999% of Drupal sites will have the settings.php file in sites/default.

So I think we should re-word this slightly to throw people a bone. Maybe:

+ - Locate your settings.php file in the /sites/* directory. (Typically sites/default.)

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Good idea.

naveenvalecha’s picture

naveenvalecha
He/Him
commented
Status: Needs work » Needs review
StatusFileSize
new drupal-mentionlocationofsettingsphp-2507911-11.patch631 bytes
new interdiff-2507911-9-11.txt620 bytes
dylf’s picture

dylf commented
Status: Needs review » Reviewed & tested by the community

Patch addresses #16

xjm’s picture

xjm
she/her
Primary language English
commented
Version: 8.0.x-dev » 7.x-dev
Assigned: dylf » Unassigned
Status: Reviewed & tested by the community » Patch (to be ported)

Thanks, this is a good improvement!

This issue only changes documentation, so per https://www.drupal.org/core/beta-changes, this can be completed any time during the Drupal 8 beta phase. Committed and pushed to 8.0.x.

Moving to 7.x for backport.

  • xjm committed e0e935b on 8.0.x 
    Issue #2507911 by mikebell_, dylanf, naveenvalecha, deepakaryan1988,...
naveenvalecha’s picture

naveenvalecha
He/Him
commented
Status: Patch (to be ported) » Needs review
StatusFileSize
new drupal-mentionlocationofsettingsphp-2507911-22.patch611 bytes
dylf’s picture

dylf commented
Status: Needs review » Reviewed & tested by the community

Patch does exactly the same thing as the 8.x patch.

David_Rothstein’s picture

David_Rothstein commented
Status: Reviewed & tested by the community » Fixed

Committed to 7.x - thanks!

  • David_Rothstein committed e2050b5 on 7.x 
    Issue #2507911 by naveenvalecha, mikebell_, dylanf, deepakaryan1988,...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.