WordPress.org

Make WordPress Core

Opened 16 months ago

Last modified 9 months ago

#23025 new defect (bug)

Review and update readme.html

Reported by: helen Owned by:
Milestone: Future Release Priority: normal
Severity: normal Version:
Component: Help/About Keywords: has-patch commit
Focuses: Cc:

Description

While this should likely be done more toward the middle or end of the cycle, let's not forget to take a good look at readme.html and its contents.

Attachments (6)

23025.patch (4.9 KB) - added by chrisrudzki 12 months ago.
23025-1.patch (5.5 KB) - added by chrisrudzki 12 months ago.
23025-2.patch (11.0 KB) - added by chrisrudzki 12 months ago.
23025-3.patch (11.0 KB) - added by chrisrudzki 12 months ago.
Changes in 23025-2.patch and Notepad++ suggestion
23025.2.patch (11.0 KB) - added by DrewAPicture 9 months ago.
23025.diff (3.6 KB) - added by nacin 9 months ago.

Download all attachments as: .zip

Change History (19)

comment:1 nacin16 months ago

Dropping the sections on XML-RPC, Post by Email, and User Roles seem sufficient.

comment:2 follow-up: chrisrudzki12 months ago

  • Cc chrisrudzki@… added
  • Keywords has-patch added
  • Removed XML-RPC, Post by Email, and User Roles sections

Other minor updates:

  • Replaced 'WordPad' reference with more common editors 'TextEdit' and 'Notepad'
  • Updated old reference to profile page -- from 'Profile' to 'Users -> My Profile'
  • Updated version to 3.6

chrisrudzki12 months ago

comment:3 markoheijnen12 months ago

Why dropping XML-RPC? Why not changing the text a bit by dropping only Atom Interface and adding the mobile apps to it

comment:4 chrisrudzki12 months ago

I think it's worth dropping XML-RPC as it's been enabled by default anyway, and it's probably worth moving toward a more accessible / less technical readme doc. I think adding some links to the mobile apps is a good idea.

I'm adding a couple more patches here:

  • 23025-1.patch includes the changes listed above, and also adds links to mobile apps
  • 23025-2.patch includes all the changes listed above, and others:
    • Removed links that are only useful after WordPress is installed
    • Replaced these with sample URLs, and menu references
    • Added 'Getting Started' section
    • Other minor changes

chrisrudzki12 months ago

chrisrudzki12 months ago

comment:5 in reply to: ↑ 2 ; follow-up: SergeyBiryukov12 months ago

Replying to chrisrudzki:

Replaced 'WordPad' reference with more common editors 'TextEdit' and 'Notepad'

Notepad++ might be a better suggestion for Windows. It handles Unix line breaks properly and saves PHP files without UTF-8 byte order mark (BOM) by default, which is crucial for international users.

Warning: Cannot modify header information - headers already sent by (output started at /home/user/site/public_html/wp-config.php:1) has been the top FAQ entry on ru.forums.wordpress.org for years now. The warning is caused by BOM after editing wp-config.php in the default Windows Notepad, so we specifically recommend against using it.

chrisrudzki12 months ago

Changes in 23025-2.patch and Notepad++ suggestion

comment:6 in reply to: ↑ 5 chrisrudzki12 months ago

Replying to SergeyBiryukov:

Notepad++ might be a better suggestion for Windows. It handles Unix line breaks properly and saves PHP files without UTF-8 byte order mark (BOM) by default, which is crucial for international users.

That's certainly good to know! TextEdit seems to save files without BOM by default, so it should be okay. I've updated the second version (23025-2.patch​) accordingly, which is the one I favor.

comment:7 nacin9 months ago

  • Component changed from Text Changes to Help/About

DrewAPicture9 months ago

comment:8 DrewAPicture9 months ago

  • Cc xoodrew@… added

23025.2.patch:

  • adds a line about generating unique keys and salts
  • fixes the tone in several places
  • updates the URLs for the theme and plugin repositories as well as the mobile link

comment:9 SergeyBiryukov9 months ago

Is there a reason for changing the wp-admin links to plain text in 23025.2.patch?

comment:10 SergeyBiryukov9 months ago

Nevermind, the change actually comes from 23025-2.patch and is mentioned in comment:4.

nacin9 months ago

comment:11 nacin9 months ago

  • Keywords commit added

It's a bit too late now for major changes, as this file needs to be manually processed by translators.

23025.diff removes four outdated sections and fixes a single grammar issue. We can play with this more in 3.7.

comment:12 nacin9 months ago

In 24744:

Remove old, less relevant and in some cases obsolete readme sections. see #23025.

comment:13 nacin9 months ago

  • Milestone changed from 3.6 to Future Release
Note: See TracTickets for help on using tickets.