WordPress.org

Make WordPress Core

Opened 10 years ago

Closed 10 years ago

Last modified 9 years ago

#10835 closed task (blessed) (fixed)

Readme.html cleanups, rework

Reported by: niallkennedy Owned by:
Milestone: 3.0 Priority: normal
Severity: normal Version: 2.9
Component: Upgrade/Install Keywords: has-patch commit
Focuses: Cc:
PR Number:

Description

I reworked readme.html and related CSS in an attempt to better explain WordPress to first-time users.

Bigger changes

  • Break up "recommendations" section into "requirements" and "recommendations" sections. Matches wording in WP.org requirements page.
  • Link to PHP and MySQL homepages (and cron on Wikipedia), just in case it's not obvious to someone.
  • Add mod_rewrite as a recommendation.
  • Note that WordPress 1.5 template changes only are likely to apply if you have a WordPress install from before Feb 2005.
  • Link WordPress logo on top of page to WordPress.org. Add image dimensions to avoid page redraw.
  • Change links and text for XML-RPC tools to reflect their current names and homepages. This paragraph seems geared towards the blogging world of 2005; there have been a few name and ownership changes since.
  • Add a link to WordPress import tools list in wp-admin.

Smaller changes

  • New css for dt and dd elements to match li and p font size and spacing.
  • Add title attributes to some links to better describe destination content (user-facing in tooltip).
  • Convert named HTML entities to UTF code point equivalents to match document style, doctype syntax, and lookup speed.
  • Add nofollow link relationship to install and upgrade links to prevent discourage search crawlers hitting those links.
  • Add abbreviations (abbr) where appropriate to expand content meaning. e.g. <abbr title="WordPress">WP</abbr>
  • Remove suggestion to bookmark and constantly check wp dev blog. Encourage users to check their admin dashboard module instead.
  • Explicitly specify GPLv2 instead of just GPL.

Attachments (3)

readme.diff (18.2 KB) - added by niallkennedy 10 years ago.
readme.html and install.css changes, with install.css minify
readme-refreshed.diff (18.9 KB) - added by xibe 10 years ago.
Refreshed patch.
readme-refreshed.2.diff (19.0 KB) - added by scribu 10 years ago.
more logical section order

Download all attachments as: .zip

Change History (17)

@niallkennedy
10 years ago

readme.html and install.css changes, with install.css minify

#1 @Txanny
10 years ago

About all changes included here, I think the change in the GPL license text by including the license version is really important.

I asked to an IP lawyer and told me that because no version is stated there and linking to the license file, then the clause 9 of the license would apply where it says "If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation."

The lawyer also highly recommended me to include the GPL version number before the link if we don't want to allow the use of any other license version. Just writing the version would avoid confusion.

The lawyer also recommended me to fully follow the license guidelines recommendations by including the copyright and license information at the very top of each source code file.

#2 @dd32
10 years ago

  • Keywords dev-feedback added
  • Milestone changed from Unassigned to 3.0

A quick look through the changes here seems to be a positive step. Marking for dev-feedback from others.

#3 @nacin
10 years ago

On the whole, the diff looks good.

The abbr handling is a good effort, though I think WP should be spelled out instead of adding <abbr> tags. There is probably a reason why Michael doesn't have his last name in there as well.

#4 @scribu
10 years ago

  • Keywords needs-patch added; has-patch dev-feedback removed

Patch needs refresh.

@xibe
10 years ago

Refreshed patch.

#5 @xibe
10 years ago

  • Keywords has-patch added; needs-patch removed

Patch refreshed for current trunk.

@scribu
10 years ago

more logical section order

#6 @scribu
10 years ago

  • Keywords commit added

In readme-refreshed.2.diff:

  • reordered the sections slightly
  • renamed =Upgrade from other systems= to =Migrate from other systems=
  • moved the b2log note to =Copyright=
  • moved the donation note to =Share the love=

#7 @nacin
10 years ago

(In [13517]) Check in install.css for [13516]. Bump version, include version in readme.html. see #10835

#8 @nacin
10 years ago

(In [13516]) First pass on readme.html updates.

Include references to the automatic upgrader, the wp-config.php creation script, the new user/pass selection during install.

Split system recommendations into requirements and recommendations. Style dt/dl/dd elements. Remove archaic v1.2 to 1.5 theme template reference. Change wording in post via mail and user roles, as neither are new features.

Props niallkennedy for minor cleanups in the commit.

#9 @toscho
10 years ago

  • Cc toscho added

The cleanup should imho fix the font-size problem: This file must be readable, but the install.css declares currently ›font-size: 12px;‹, which makes the whole procedure unnecessary hard.
Using 1em for the body text is the best way to guarantee readability.

#10 @nacin
10 years ago

  • Type changed from enhancement to task (blessed)

#11 follow-up: @nacin
10 years ago

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

(In [13986]) A few more readme.html tweaks. fixes #10835

#12 @hakre
9 years ago

Tag: FIXIPO

#13 in reply to: ↑ 11 ; follow-up: @hakre
9 years ago

Replying to nacin:

(In [13986]) A few more readme.html tweaks. fixes #10835

Your commit introduced an unauthorized change of the licensing.

This is backed up by markjaquith:

I'm going to revert.

The problematic part of it has been removed (it has to be GPL, not GPLv2) as of now.

Related:
#14685
[15533] - For trunk
[15534] - For 3.0

#14 in reply to: ↑ 13 @aaroncampbell
9 years ago

Replying to hakre:

Replying to nacin:

(In [13986]) A few more readme.html tweaks. fixes #10835

Your commit introduced an unauthorized change of the licensing.

Just a clarification - the GPLv2 issue was introduced in [13516] not [13986]

Note: See TracTickets for help on using tickets.