Opened 5 months ago

Last modified 5 weeks ago

#23025 new defect (bug)

Review and update readme.html

Reported by: helen Owned by:
Priority: normal Milestone: 3.6
Component: Text Changes Version:
Severity: normal Keywords: has-patch
Cc: chrisrudzki@…

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 (4)

23025.patch (4.9 KB) - added by chrisrudzki 5 weeks ago.
23025-1.patch (5.5 KB) - added by chrisrudzki 5 weeks ago.
23025-2.patch (11.0 KB) - added by chrisrudzki 5 weeks ago.
23025-3.patch (11.0 KB) - added by chrisrudzki 5 weeks ago.
Changes in 23025-2.patch and Notepad++ suggestion

Download all attachments as: .zip

Change History (10)

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

comment:2 follow-up: ↓ 5   chrisrudzki5 weeks 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

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

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

comment:5 in reply to: ↑ 2 ; follow-up: ↓ 6   SergeyBiryukov5 weeks 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.

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

comment:6 in reply to: ↑ 5   chrisrudzki5 weeks 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.

Note: See TracTickets for help on using tickets.