Make WordPress Core

Opened 4 years ago

Closed 15 months ago

Last modified 15 months ago

#50886 closed defect (bug) (fixed)

docs: Improve help text about site vs. WordPress URL settings

Reported by: tobifjellner's profile tobifjellner Owned by: marybaum's profile marybaum
Milestone: 6.2 Priority: normal
Severity: normal Version:
Component: Help/About Keywords: has-patch commit
Focuses: ui, docs, administration, ui-copy Cc:

Description

Hi,
I'm looking at https://build.trac.wordpress.org/browser/trunk/wp-admin/options-general.php?marks=30#L30
and thinking about how to improve the help string:
"The WordPress URL and the Site URL can be the same (example.com) or different; for example, having the WordPress core files (example.com/wordpress) in a subdirectory instead of the root directory."

  1. Since the URL's should include http/https, I believe the sample should also have that: "https://example.com)
  2. It would be good to elaborate a bit more on the difference between these two URL's. What about "WordPress URL is where the core files of WordPress are installed. Site URL is the URL a visitor enters in their browser in order to reach your site."
  • Perhaps we should also mention here about http/https specifically?
  • What about: Remember that if you want to move your site to a different domain, you'll usually need to first configure this outside of WordPress.

Attachments (4)

Improve_help_text_per_ticket_#50886.patch (82.2 KB) - added by marybaum 3 years ago.
Patch with new copy
50886.diff (31.1 KB) - added by SergeyBiryukov 22 months ago.
50886-reduced.diff (3.5 KB) - added by marybaum 20 months ago.
Removed all the changes that don't belong to the specific text of this ticket and applied the patch to a local install.
50886-comment 24.patch (2.8 KB) - added by marybaum 19 months ago.
A new patch in response to comment 24 discussion, and a thought I had about the basic security copy.

Download all attachments as: .zip

Change History (54)

#1 @SergeyBiryukov
4 years ago

  • Component changed from General to Text Changes
  • Focuses ui added

#2 in reply to: ↑ description @justinahinon
4 years ago

Replying to tobifjellner:

  1. Since the URL's should include http/https, I believe the sample should also have that: "https://example.com)

I agree on point 1, about adding http/https to the URL. But I'm wondering, should we include both? The https://example.com and http://example.com?

  1. It would be good to elaborate a bit more on the difference between these two URL's. What about "WordPress URL is where the core files of WordPress are installed. Site URL is the URL a visitor enters in their browser in order to reach your site."

Yeah, it makes sense IMO to rephrase the original sentence. @marybaum, I'd love to have your feedback about the proposed wording :).

  • Perhaps we should also mention here about http/https specifically?

What if we include instead a link to a resource that clarify that. We don't want the help panel to be also very long I think.

  • What about: Remember that if you want to move your site to a different domain, you'll usually need to first configure this outside of WordPress.

+1

#3 @SergeyBiryukov
4 years ago

#50883 was marked as a duplicate.

#4 @SergeyBiryukov
4 years ago

  • Focuses ui-copy added

#5 @sabernhardt
3 years ago

  • Component changed from Text Changes to Help/About

This ticket was mentioned in Slack in #core by abhanonstopnews. View the logs.


3 years ago

This ticket was mentioned in Slack in #core by docpop. View the logs.


3 years ago

@marybaum
3 years ago

Patch with new copy

#8 @marybaum
3 years ago

Just added a patch with new copy:

Explains the difference between site and WP URLs.
Changes passive verbs to active.
Addresses http versus https.

Please feel free to make cuts!

This ticket was mentioned in Slack in #core by marybaum. View the logs.


3 years ago

#10 @marybaum
3 years ago

Props webcommsat, hellofromtonya

This ticket was mentioned in Slack in #core by abhanonstopnews. View the logs.


2 years ago

#12 @marybaum
2 years ago

Looks like this patch could use some review and testing. I will test the patch and, if it works properly (it's copy ... so I'm optimistic) then I'll ask for review toward commit in this week's devchat.

#13 @webcommsat
2 years ago

Discussed in bug scrub. Text in @marybaum's patch reviewed. A new patch will be needed to incorporate the other changes to text and @marybaum's text changes too. @snoozeulose to look at the wording and draft a patch. Thanks to all those who came to discuss the ticket.

Last edited 2 years ago by webcommsat (previous) (diff)

This ticket was mentioned in Slack in #core by flexseth. View the logs.


2 years ago

This ticket was mentioned in Slack in #core by marybaum. View the logs.


22 months ago

#16 @SergeyBiryukov
22 months ago

  • Milestone changed from Awaiting Review to 6.1

#17 follow-up: @audrasjb
22 months ago

  • Keywords changes-requested added

I think the part of the patch that is replacing can't with cannot in QUnit tests comes from another patch, and shouldn't be there :)

#18 @audrasjb
22 months ago

And same goes for other unrelated files ;-)

#19 in reply to: ↑ 17 @SergeyBiryukov
22 months ago

Replying to audrasjb:

I think the part of the patch that is replacing can't with cannot in QUnit tests comes from another patch, and shouldn't be there :)

Yes, there are quite a few unrelated changes, mostly from [52978], [53131], [53182], and their earlier iterations. If these suggestions were properly uploaded and discussed on #38913 instead of Slack at the time, they would have been much easier to review :)

I was able to refresh the patch by:

  • Checking out an earlier revision from the date the patch was submitted, i.e. [52111].
  • Applying the patch.
  • Resolving merge conflicts manually and trying to separate meaningful edits from unrelated changes.

50886.diff should only include legitimate copy edits (apologies if I missed some when resolving the conflicts), though most are still unrelated to this ticket and should be moved to a new one to avoid further confusion. Looks like some were meant for #38913 but never made it to core due to not being uploaded to the ticket, others are just various edits using simpler language or replacing passive voice with active.

The changes relevant to this ticket are in wp-admin/options-general.php. I have not reviewed them yet, it should be easier once the other changes are moved to a separate ticket.

Last edited 22 months ago by SergeyBiryukov (previous) (diff)

@marybaum
20 months ago

Removed all the changes that don't belong to the specific text of this ticket and applied the patch to a local install.

#20 @marybaum
20 months ago

  • Keywords has-patch needs-testing added; changes-requested removed

#21 @sabernhardt
20 months ago

Small edit: remove the space from the https:// example.com URL.

Last edited 20 months ago by sabernhardt (previous) (diff)

This ticket was mentioned in Slack in #core by marybaum. View the logs.


20 months ago

#23 follow-up: @sabernhardt
20 months ago

  • Milestone changed from 6.1 to 6.2

Unless a committer wants to add this within the next week, let's revisit the ticket in the next release cycle.

In addition to the typo fix, I have a few suggestions:

  1. The padlock is not always to the left of the address. Right-to-left language translators could correct that to the right, but "next to" would fit either language direction.
  2. Wrapping the URL examples and HTTP(S) protocols with code tags can help as well. The text string with protocols could use sprintf with placeholders. The URL example should be translatable (French has exemple.fr), so that might involve adding the code tags within the string.
  3. I don't like the "reach your objectives" phrase, mainly because building trust is a fundamental objective in itself (without visitors' trust, how can anyone sell, inform, persuade, etc.?). One simple option is to end the sentence at "search engines." Another option is to combine the first part of that sentence with the second part of the previous sentence: "Both of those things signal to visitors that your site meets some basic security requirements, which can build trust with your users and with the search engines."

#24 in reply to: ↑ 23 @webcommsat
20 months ago

Replying to sabernhardt:
I agree let's move this to 6.2.
On your other points:

  1. Yes let's change the text to 'next to'
  1. A slight tweak of both of your text to:

"Both of those things signal to visitors that your site meets some basic security requirements, which can build trust with your users and with search engines."

@marybaum over to you to make this change in 2) and 1) and 3), and remove the space in the url (comment 21)?

Thanks @sabernhardt and @marybaum .

Unless a committer wants to add this within the next week, let's revisit the ticket in the next release cycle.

In addition to the typo fix, I have a few suggestions:

  1. The padlock is not always to the left of the address. Right-to-left language translators could correct that to the right, but "next to" would fit either language direction.
  2. Wrapping the URL examples and HTTP(S) protocols with code tags can help as well. The text string with protocols could use sprintf with placeholders. The URL example should be translatable (French has exemple.fr), so that might involve adding the code tags within the string.
  3. I don't like the "reach your objectives" phrase, mainly because building trust is a fundamental objective in itself (without visitors' trust, how can anyone sell, inform, persuade, etc.?). One simple option is to end the sentence at "search engines." Another option is to combine the first part of that sentence with the second part of the previous sentence: "Both of those things signal to visitors that your site meets some basic security requirements, which can build trust with your users and with the search engines."

This ticket was mentioned in Slack in #core by abhanonstopnews. View the logs.


20 months ago

#26 @audrasjb
19 months ago

  • Keywords changes-requested added; needs-testing removed

#27 @marybaum
19 months ago

I had a thought about the trust copy that I've written into the latest patch.

@marybaum
19 months ago

A new patch in response to comment 24 discussion, and a thought I had about the basic security copy.

#28 @marybaum
19 months ago

  • Keywords needs-testing added; changes-requested removed
  • Owner set to marybaum
  • Status changed from new to assigned

#29 @marybaum
19 months ago

Oh. Also changed concatenated strings to sprintf because, well, security ;-D

#30 @robinwpdeveloper
16 months ago

Patch looks good at the moment.
I have two suggestions. If intentional then we can keep as it is too.

Patch: https://core.trac.wordpress.org/attachment/ticket/50886/50886-comment%2024.patch

Proposing:
The WordPress URL is the where the core WordPress installation files are, and the site URL is the address a visitor uses in the browser to get go to your site.

Changes to make:

  • Remove the
  • Replace get with go

This ticket was mentioned in PR #4064 on WordPress/wordpress-develop by @sabernhardt.


16 months ago
#31

Combines patches from Trac 50886 for General Settings page

#32 @sabernhardt
16 months ago

Proposed new text (for single sites):

Most themes show the site title at the top of every page, in the title bar of the browser, and as the identifying name for syndicated feeds. Many themes also show the tagline.

Two terms you will want to know are the WordPress URL and the site URL. The WordPress URL is where the core WordPress installation files are, and the site URL is the address a visitor uses in the browser to go to your site.

Though the terms refer to two different concepts, in practice, they can be the same address or different. For example, you can have the WordPress core files in the root directory (https://example.com), in which case the two URLs would be the same. Or the WordPress files can be in a subdirectory (https://example.com/wordpress). In that case, the site URL and the WordPress URL would be different.

Both site URLs and WordPress URLs can start with either http:// or https://. A URL starting with https:// will also show a padlock next to the address in the browser address bar. Both of those things signal to visitors that your site meets some basic security requirements, which can build trust with your users and with search engines.

If you want site visitors to be able to register themselves, check the membership box. If you want the site administrator to register every new user, leave the box unchecked. In both cases, you can set a default user role for all new users, whether they register themselves or a site admin registers them.

You can set the language, and WordPress will automatically download and install the translation files (available if your filesystem is writable).

Notes:

  1. The PR includes code tags.
  2. In addition to explaining Site URLs and WordPress URL, this includes changing two strings to replace passive voice. One of these strings is also in network settings.
  3. I had tried splitting the reminder to save into its own text string so the old translations would remain valid. But then I removed that part from the patch because I'm not comfortable editing it in six files for this ticket. It could deserve a separate discussion.
  4. 50886-comment 24.patch proposed "Both of those things signal to visitors that your site is authentic, and the people who run it are real." However, I prefer the sentence that talks about building trust.

@audrasjb commented on PR #4064:


16 months ago
#33

The patch looks good to me. Only wondering whether it would be useful to point people to this HelpHub link?

@sabernhardt commented on PR #4064:


16 months ago
#34

The HelpHub link was already directly below the Site Address field, but it's probably worth including in both places.

@audrasjb commented on PR #4064:


16 months ago
#35

Ah you're right. In that case, I'm not sure it's worth having it on both locations

@sabernhardt commented on PR #4064:


16 months ago
#36

I updated the documentation URL. I'm more inclined to add the link, even if people might ignore it, in case someone does want it there. If the link should be removed, though, reverting the last two commits would be easy enough.

@audrasjb commented on PR #4064:


16 months ago
#37

Thinking about it, I think we should put that link back in the help tabs anyway, because it's useful to have it in that context too 👍

#38 @sabernhardt
15 months ago

@costdev suggested a few changes to the PR:

  1. Consistently mentioning WordPress URL before site URL.
  2. Reusing "core WordPress installation files" instead of "WordPress core files": 'For example, you can have the core WordPress installation files in the root directory (https://example.com), in which case the two URLs would be the same.'
  3. Reducing repetition in the default user role sentence (and I edited "In both cases" to "In either case"): 'In either case, you can set a default user role for all new users.'

This ticket was mentioned in Slack in #core by mukeshpanchal27. View the logs.


15 months ago

#40 @costdev
15 months ago

  • Keywords commit added; needs-testing removed

This ticket was discussed during the bug scrub. As feedback on the PR has been addressed, I think this one is ready for commit consideration.

Adding the keyword and pinging @audrasjb to take a look regarding this comment on the PR - does this still need to be done or?

Additional props: @mukesh27

#41 @SergeyBiryukov
15 months ago

Both WordPress URLs and site URLs can start with either http:// or https://. A URL starting with https:// will also show a padlock next to the address in the browser address bar. Both of those things signal to visitors that your site meets some basic security requirements, which can build trust with your users and with search engines.

I think this part can be confusing, as it does not mention that https:// only works if you set up an SSL certificate, or if the hosting provider does that for you. I've seen people on support forums with this exact issue, changing these URLs to https:// before setting up SSL and then asking why the site can no longer be opened.

The suggested text seems to encourage changing the URLs to https:// without explaining the consequences.

Should we try to clarify that here?

Last edited 15 months ago by SergeyBiryukov (previous) (diff)

#42 @SergeyBiryukov
15 months ago

  • Keywords changes-requested added; commit removed

@costdev commented on PR #4064:


15 months ago
#43

@SergeyBiryukov How does this sound?

Both WordPress URLs and site URLs can start with either http:// or https://. A URL starting with https:// requires an SSL certificate, so be sure that you have one before changing to https://. With https://, a padlock will appear next to the address in the browser address bar. Both https:// and the padlock signal to visitors that your site meets some basic security requirements, which can build trust with search engines and your visitors.

@audrasjb commented on PR #4064:


15 months ago
#44

Sounds great to me 👍

#45 follow-up: @costdev
15 months ago

@SergeyBiryukov @audrasjb With the feedback on the PR addressed, do you think this one can be committed before the 6.2 Beta 4 release party as we're entering soft-string freeze?

Last edited 15 months ago by costdev (previous) (diff)

@sabernhardt commented on PR #4064:


15 months ago
#46

The proposed text is good, but I specifically want visitors before search engines in the last sentence.

I updated the PR in case it's worth committing this late in the cycle. However, with soft string freeze today, this ticket probably should be moved to 6.3.

#47 in reply to: ↑ 45 @SergeyBiryukov
15 months ago

  • Keywords commit added; changes-requested removed

Replying to costdev:

With the feedback on the PR addressed, do you think this one can be committed before the 6.2 Beta 4 release party as we're entering soft-string freeze?

Yes, looks good to me now :)

This ticket was mentioned in Slack in #core by costdev. View the logs.


15 months ago

#49 @SergeyBiryukov
15 months ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 55452:

Help/About: Improve help text about the WordPress URL and Site URL settings.

This aims to elaborate a bit more on the difference between these two settings, as well as explain the http:// or https:// prefix.

Follow-up to [15000], [19472].

Props marybaum, sabernhardt, tobifjellner, justinahinon, webcommsat, hellofromtonya, audrasjb, robinwpdeveloper, costdev, SergeyBiryukov.
Fixes #50886.

@SergeyBiryukov commented on PR #4064:


15 months ago
#50

Thanks for the PR! Merged in r55452.

Note: See TracTickets for help on using tickets.