Review changes to Upgrade process page [#1016834]

coming from http://drupal.org/node/538054#comment-3892944 (install guide issue)

i've reverted back from this version, http://drupal.org/node/570162/revisions/1291174/view due to formatting being extremely off from the styleguide, needs re-review and updating of content potentially, with more usual formatting. (there are some specific notes about heading styles at the bottom of this section of the styleguide http://drupal.org/node/338208#headings - the style guide itself is a good example of acceptable formatting).

please have a look at the previous version to see content changes that have been reverted.

Comments

Comment #1

uNeedStuff commented 9 January 2011 at 03:19

I don't understand what the style issue is, each step has been given it's own heading, is that what you mean?
It should have it's own heading, and the more detailed explanation under it. It's not a text document but a steps document.

Comment #2

arianek commented 9 January 2011 at 07:18

No, each step should not be a heading (especially when there is no text below the heading). If you are writing steps, they should be in an ordered list, as it was before the edits. If it's very long, you can have a few different sections of lists split up by headings. But practically each line was a heading, which is not easy to read or in line with other pages' formatting.

Note: The older version I reverted to needs a tiny bit of formatting cleanup (and a technical review/update), but nothing major.

Comment #3

uNeedStuff commented 12 January 2011 at 01:44

I guess it's a matter of opinion on the readability and use of headings. I didn't really see that covered in what you point me to. I find ordered list are not how to friendly especially when there is a need for further information or clarification, nor do I find them easy to read.

Comment #4

arianek commented 29 March 2011 at 03:59

Issue tags:

+upgrade guide, +Sprint: April 2011

Comment #5

eliza411 commented 12 April 2011 at 21:49

Status:

Active

» Fixed

I ran a test upgrade against the directions as they existed in http://drupal.org/node/570162/revisions/1435672/view (plus the small edit I made after that, but I don't know how to point at that revision). Everything went as expected with a complex site.

I reviewed the comments and deleted those that reflected earlier versions of the document and incorporated the one that was appropriate.

Although this didn't get set to needs review, since I'm reviewing it at arianek's request during the sprint, I'm marking this as fixed. If that was inappropriate, please re-open.