Copy editing guideline for this issue

Check that the terms Upgrade and Update are used correctly.

  • Upgrade means changing the software version from one major version of Drupal to another, and adapting the site, database, and code to this new version.
  • Update is anything less than that, such as moving to a new version of a particular module or the core software.

Task Instructions

  1. To claim this task, assign this issue to yourself (see instructions below). Only claim a task if you can complete it in about two weeks.
  2. See the instructions below to "clone" the guide, edit the entire user guide so that it follows the above copy editing guideline, and make a patch file. Do not make other edits at this time -- other edits will be taken care of in other issues. If you find that you cannot complete the whole task, but have made some progress, make a patch file for the part you've done.
  3. Upload the patch file to this issue, in the Files section.
  4. Set the Issue Status to Needs Review, in the Issue Metadata section.
  5. Write a comment stating what you've done.
  6. In this comment, add "Attribution" information
    https://www.drupal.org/u/msmith[Mary Smith]
    or
    https://www.drupal.org/u/jsmith[Joe Smith] of https://example.com[Example Company]
    
  7. Someone will review your work, and either accept it, or set it back to Needs Work for more attention.
  8. If the status is set to Needs Work, make the requested changes, make a new patch file, and upload it. Iterate until it is fixed.

Detailed Instructions for Assigning Issues and Patching

Assigning an issue to yourself

  1. Scroll to the bottom of the issue to Add new comment.
  2. Open the "Issue metadata" section if it is collapsed.
  3. Put your user name in the "Assigned" field, add a short comment stating that you are claiming the task, and Save.

Editing and making a patch file

  1. In order to make a patch file, you will need to use the Git version control software. There are generic instructions on Git at: https://www.drupal.org/documentation/git/ -- if you have never used Git, you will probably want to read the introductory material, and you'll need to install Git.
  2. Specific Git instructions for the User Guide project can be found at https://www.drupal.org/project/user_guide/git-instructions . Follow the instructions to "clone" the repository (see the "One-time only" instructions).
  3. Make the edits for this issue, using a plain-text editor. The source files are located in the source/en subdirectory, and have extension .txt, and are in AsciiDoc format (see below).
  4. Go back to the specific Git instructions page and follow the instructions there to make a patch file. There are also more detailed git patch instructions in the Git documentation section linked above.

AsciiDoc formatting

The documentation in this project is formatted using AsciiDoc. The Formatting page in the User Guide guidelines (login: drupal / drupal ) has links and details for how to format text properly, make cross-links between topics, etc.

Comments

ifrik created an issue. See original summary.

ifrik’s picture

Status: Active » Needs work
StatusFileSize
new1.8 KB

On https://userguide_new-drupal.dev.devdrupal.org/d8guide/en/config-basic.html which I used for creating this issue, "update" was used as a synonym for changing or editing content, so I changed that.

I haven't looked at any other files.

ifrik’s picture

Status: Needs work » Active

I've removed the patch that only patched config-basic.txt here to include it in the larger patch in #2699005: Copy edit two references pages instead.

ifrik’s picture

jhodgdon’s picture

I've now centralized instructions for the editing tasks. I'll go ahead and leave the instructions on these issues, but you can also go to
https://userguide_new-drupal.dev.devdrupal.org/guidelines/instructions.h...
(log in with drupal / drupal)
and follow the instructions there (probably more complete).

cleverington’s picture

Assigned: Unassigned » cleverington
cleverington’s picture

Status: Active » Needs review
StatusFileSize
new8.57 KB

First patch, so forgive me if something is off. (and let me know what I messed up ^-^)

Finished copy/edit for 'update' based on understanding. Used 'alter' in many cases, but left 'update' in place for areas where the instructions were referring to 'field' alterations (since those have an 'Update' button).

Finished:

  • updates
  • update



Still in need of review:

  • updated
  • updating
  • upgrade
  • upgrading
  • upgraded



If the current patch meets the Doc-Team's expectations, I'll move forward with the rest of the copy-edit review.

ifrik’s picture

Status: Needs review » Needs work

Thanks cleverington,

this looks good so far. Another word you can use for variety is "edit" when content is changed.

So, yes pleas, go on with it :-)

jhodgdon’s picture

Actually, I think it is probably OK to use the word "update" outside the context of module/Drupal upping of versions. Especially since, as you point out, sometimes the button says "update" on it.

If you want to change them, that is OK too. Synonyms to consider:
- change
- edit
- alter
... can't think of anything else...

So, looking at this patch, here are some thoughts:

  1. +++ b/source/en/config-theme.txt
    @@ -77,11 +77,11 @@ changed on your site, select "Save configuration" at the bottom of the Bartik
    -//To create this image: followed all above steps of updating colors and logo, then took a screen shot including the "Preview" title with example preview of front page with updated settings.
    +//To create this image: followed all above steps of updating colors and logo, then took a screen shot including the "Preview" title with example preview of front page with changed settings.
    

    The comments (lines starting with // in source files) are not shown in the User Guide. They are only for the use of editors. So I wouldn't bother making any changes in any comment lines.

  2. +++ b/source/en/config-theme.txt
    @@ -77,11 +77,11 @@ changed on your site, select "Save configuration" at the bottom of the Bartik
    -. Congratulations! You have updated the Bartik theme settings for your website.
    +. Congratulations! The Bartik theme settings are configured for your website.
    

    This change seems fine to me.

  3. +++ b/source/en/content-edit.txt
    @@ -6,7 +6,7 @@
    -Edit a previously-created content item; in this example, we'll update the
    +Edit a previously-created content item; in this example, we'll change the
    

    This is good too. Maybe though we should use "edit" in the context of changing a page or other content, since the links in the UI all say "Edit" on them? That would promote thinking of it that way, I think?

  4. +++ b/source/en/content-edit.txt
    @@ -22,7 +22,7 @@ to edit it.
    -. If the content item you want to edit was updated or created recently, it
    +. If the content item you want to edit was changed or created recently, it
    

    Well this is an excellent place for using "changed", because it would be very awkward to say "... the item you want to edit was edited recently"... hard to parse. So this wording is good. :)

  5. +++ b/source/en/content-edit.txt
    @@ -49,10 +49,10 @@ image:images/content-edit-revision.png["Screen shot of the revision information
    +image:images/content-edit-message.png["Screen shot of Content page with changed content message showing"]
    

    In this case, if you look at the screen shot, the message on the screen actually says:

    Basic page Home has been updated.

    So here... it may be best to leave it as "updated"? Maybe the same for a few lines up in the text?

  6. +++ b/source/en/planning-modular.txt
    @@ -36,8 +36,8 @@ number.
    +vendor information is altered, all recipe pages that display that vendor
    +information are automatically altered; when a recipe is submitted by a vendor,
    

    This looks good to me.

  7. +++ b/source/en/preface-audience.txt
    @@ -6,7 +6,7 @@ content management system who would like to become skilled at installing,
     website. The guide is also aimed at people who already have some experience
     with a current or past version of Drupal, and want to expand the range of their
    -skills and knowledge or update them to the current version.
    +skills and knowledge or catch up to the current version.
    

    Here I think "update" is appropriate. We're talking about "updating your skills", and "catch up" is a bit more colloquial.

  8. +++ b/source/en/prevent-backups.txt
    @@ -25,7 +25,7 @@ that is separate from the computer where your site is running.
    +large amount of content on your site that is being added to or altered many
     times per day, you would want to make more frequent backups than you would for a
    

    Maybe "edited" here?

cleverington’s picture

Status: Needs work » Needs review
StatusFileSize
new7.42 KB

(Patching is surprisingly easy now that my knowledge of git has improved...)

Copy-editing done, but 'upgrade' only appears a few times in the whole document.

I assume this was already addressed previously, but I have been out of the loop due to college (which is thankfully over…).

I am guessing there is not a section for “Upgrading Drupal Core” because of the assumption that the Upgrade instructions from Drupal 8 to Drupal 9 will be released at a later date and this Guide is focused solely on Drupal 8.

Searching 239 files for "upgrade"

~/Projects/personal-projects/user_guide/source/en/security-update-core.txt:
  139  https://www.drupal.org/project/registry_rebuild["Registry Rebuild"].
  140  
  141: You may also refer _/core/UPGRADE.txt_ within your Drupal 8 installation in case
  142  you want to learn more about updating Drupal 8 core.
  143  

~/Projects/personal-projects/user_guide/source/en/security-update-module.txt:
   44  before proceeding with the updates. To find instructions, check the module's
   45  project page _Read Documentation_ link, as well as the instructions (for
   46: example, _README.txt_, _INSTALL.txt_, and _UPGRADE.txt_) that come with the
   47  module's installation file. Also review the release notes by clicking on the
   48  version number of the download on the project page for the version you're

2 matches across 2 files

Searching 239 files for "upgrading"

0 matches

Searching 239 files for "upgraded"

0 matches

If that is not an issue, than this task can probably be resolved.

Commend update - 2016-04-10:

Edited by https://www.drupal.org/u/cleverington[Charles Leverington]

ifrik’s picture

Issue tags: +DrupalBCDays
jhodgdon’s picture

Status: Needs review » Needs work

Hm. Looking over these edits... The main point of this issue is to avoid the use of the word "update" when it should be "upgrade", and the reverse, in the context of changing to a new version of a module, theme, or the core software.

I do not really think that we should avoid the word "update" in the context of "making updates to your configuration" or "updating content" -- those seem perfectly fine to me. The Drupal user interface even uses these terms in its messages and field names, and it would be confusing if we didn't follow their lead.

So, while I very very much appreciate your enthusiasm and attention to detail... can we reverse those changes, and only fix places where we're actually referring to changing the version of software?

So the topics I see the word updat* or upgrad* in this context, which need to be checked over, are:
extend-maintenance
extend-manual-install
extend-module-find
extend-module-install
extend-theme-install
glossary
install-dev-sites
install-tools
prevent-status
security-announce
security-concept
security-update-core
security-update-module
security-update-theme
user-admin-account

Let's not make changes in any other topics. Thanks!

cleverington’s picture

Status: Needs work » Needs review

Not upset at all about the extra work, its cool.

However, I reviewed all of the files you references and none of those files have any needed edits, as best I can tell.

Thoughts, clarification or izz good?

jhodgdon’s picture

Status: Needs review » Fixed

In a quick glance... I agree with your more careful assessment. Thanks very much for taking the time to check!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.