Review and update readme.html

[helen]

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.

[nacin]

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

[chrisrudzki]

• 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

[markoheijnen]

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

[chrisrudzki]

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

[SergeyBiryukov]

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.

[chrisrudzki]

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

[chrisrudzki]

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.

[DrewAPicture]

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

[SergeyBiryukov]

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

[SergeyBiryukov]

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

[nacin]

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.

[nacin]

In 24744:

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

[chriscct7]

Continuing work in 4.4

[helen]

Closing as fixed in 3.6. There's plenty that could be done, but let's open specific tickets for specific changes, and if an overhaul is done at some point, then we'll open a ticket for it then.