Note: For guidelines and instructions pages linked below, log in with user name / password: drupal/drupal.

Task for this issue

Edit the entire User Guide for the following copy editing guideline(s):

Avoid using the word Drupal, except when referring specifically to the Drupal open-source project, the Drupal community, or the Drupal.org web site.
Instead, refer to “your site” and “the core software”.

Instructions

See https://userguide_new-drupal.dev.devdrupal.org/guidelines/instructions.h... -- but skip the section on finding a task to do, since you have selected this one.

Checklist for this task

- Is a patch file provided?
- Is the edit for the provided guidelines complete and correct?
- Is the patch free from additional edits outside the scope of the provided guidelines?
- Is attribution provided? See https://userguide_new-drupal.dev.devdrupal.org/guidelines/guidelines.htm...

Comments

ifrik created an issue. See original summary.

ifrik’s picture

Status: Active » Needs review
StatusFileSize
new900 bytes

I'm wondering about two mentions of "Drupal" on the Distributions page https://userguide_new-drupal.dev.devdrupal.org/d8guide/en/understanding-... that I use for setting up these issues.

Referring to "Drupal core" as part of the download is fine, but the general references to distributions should probably without "Drupal" because these distributions are typically called something different.

ifrik’s picture

StatusFileSize
new900 bytes

Fixed the somewhat confusing patch name.

ifrik’s picture

Status: Needs review » Active
Parent issue: #2687905: Copy edit: Avoid please and similar words »

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

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).

gdunham’s picture

Assigned: Unassigned » gdunham

I will work on this one.

jhodgdon’s picture

Issue summary: View changes

Standardizing issue summaries for the editing issues.

gdunham’s picture

Status: Active » Needs review
StatusFileSize
new20.43 KB

Here is my first effort on this issue.

What I did:
I searched all files for the term Drupal - ignoring instances used in comments, scripts, URLs and page titles.
Changed the term Drupal to the core software or your site in the other instances that did not reference the open source project or community. (I found this somewhat difficult to determine. This is my first effort and will provide further changes with guidance.)
"Attribution" information https://www.drupal.org/u/gdunham[Grant Dunham]

eojthebrave’s picture

Status: Needs review » Needs work

I've been working on this during the DrupalCon sprint, and we're about to be kicked out of the room, so I'll come back to this issue. But, here's my initial feedback.

In general, I agree, this is hard! And there seem to be a lot of cases where using "the core software" feels really ambiguous. But, I like what you've got going here so far. Thanks!

  1. +++ b/source/en/config-uninstall.txt
    @@ -9,7 +9,7 @@
    -Leaving the modules installed that are unused by your Drupal application (in our
    +Leaving the modules installed that are unused by your your application (in our
    

    Looks like "Drupal" got removed, but an extra "your" got added.

  2. +++ b/source/en/content-paths.txt
    @@ -35,7 +35,7 @@ Here are some examples of paths you might find in a Drupal site:
    -Drupal has a feature called "URL Alias" that allows you to provide a more
    +The core software has a feature called "URL Alias" that allows you to provide a more
    

    This looks like it needs to be re-wrapped to 80 characters after adding the changes.

  3. +++ b/source/en/extend-theme-find.txt
    @@ -57,7 +57,7 @@ Some aspects to pay attention to when evaluating themes:
    -* Releases: The theme should be available for your version of Drupal. Pay
    +* Releases: The theme should be available for your version of the core software. Pay
    

    Another one that needs re-wrapping. Looks like there might be a few. It's also not the end of the world, I can re-wrap these when it gets committed but would be great if you want to tackle it too.

  4. +++ b/source/en/install-prepare.txt
    @@ -19,20 +19,20 @@ pre-requisites.
    -  Use an online provider to get a demo installation of Drupal in 20 minutes or
    +  Use an online provider to get a demo installation of the core software in 20 minutes or
    

    I think this one should be left as "Drupal" since the drupal.org/try-drupal page will only ever be Drupal demos and not "generic core software". Some providers might support different distros but which ones are supported and by whom will likely vary a lot.

  5. +++ b/source/en/install-prepare.txt
    @@ -54,13 +54,13 @@ http://www.drush.org/en/master[Drush Documentation].
    -. Download Drupal core or the Drupal distribution you would like to use.
    +. Download the core software or the Drupal distribution you would like to use.
    

    I think this one should remain "Drupal" because these instructions are specific to downloading Drupal, or some other distro, from Drupal.org. Anyone wanting to adapt the guide for their specific distro should probably just edit this anyway.

  6. +++ b/source/en/menu-concept.txt
    @@ -28,7 +28,7 @@ feature. Each menu automatically creates a block of the same name. By default,
    -Drupal standard profile installation contains five menus:
    +The core software standard profile installation contains five menus:
    

    This is probably specific to "Drupal" since a different distro might have made changes to the standard install profile, or more likely, doesn't even use the standard install profile and instead uses it's own.

  7. +++ b/source/en/preface-conventions.txt
    @@ -67,7 +67,7 @@ In the _Manage_ administrative menu, navigate to
    -Navigation instructions like this assume that you have the Drupal core Toolbar
    +Navigation instructions like this assume that you have the core software Toolbar
    

    I think this might read better if we just say something like, "assume that you have the Toolbar module installed ..." and just leave out the "core software" or "Drupal" bit all together.

  8. +++ b/source/en/structure-view-modes.txt
    @@ -14,7 +14,7 @@
    -the context in which it is shown. In Drupal this context is called a _view
    +the context in which it is shown. In the core software this context is called a _view
    

    I wonder if this might be better if we just rephrase things a bit. "depends on the context in which it is shown. This context is known as a _view mode_. Examples of view ..."

    It seems like this might be a little easier than having to say "the core software"

  9. +++ b/source/en/structure-view-modes.txt
    @@ -22,7 +22,7 @@ mode_. Examples of view modes are:
    -Every view mode can be configured through the administration pages of Drupal. To
    +Every view mode can be configured through the administration pages of the core software. To
    

    Same here, I think we can just say, "Every view mode can be configured through the administration pages."

  10. +++ b/source/en/thoughts-learn-more.txt
    @@ -22,11 +22,11 @@
    -your skills with the Drupal software:
    +your skills with the core software:
    

    I would leave off "the core software" here.

    "The following resources should prove useful to you, as you continue to advance your skills." seems adequate.

  11. +++ b/source/en/thoughts-support.txt
    @@ -33,7 +33,7 @@ the other hand, all projects encourage you to use issues to report problems and
    -volunteers answer support questions about Drupal:
    +volunteers answer support questions about the core software:
    

    Lets leave this one as "drupal" since we're talking specifically about connecting with the Drupal community here.

gdunham’s picture

Status: Needs work » Needs review
StatusFileSize
new41.9 KB

I've made the changes as suggested above. (I think I've done the line wrapping modification - and can do all of the files if I'm on the correct path.)

jhodgdon’s picture

Status: Needs review » Needs work

I took a look at this patch, but there are many many wrapping problems.

We do want most text in the file to be wrapped to 80 character or less lines -- but not all (for instance, comment lines are sometimes longer, and there are certain other things that have to stay on one line for AsciiDoc to format them properly).

However, this issue is about avoiding the word Drupal. So, you should (a) make changes in the text to comply with that policy and (b) only rewrap lines where those particular changes makes a line go over 80 characters. Don't change the wrapping elsewhere.

When I look at this latest patch, most of it seems to be unrelated to the issue here... you might need to start over with the previous patch. Thanks!

gdunham’s picture

Status: Needs work » Needs review
StatusFileSize
new19.09 KB

I've cloned a fresh copy of the guide.
I've made the changes proposed in the patch in comment 8 and then made the changes suggested by eojthebrave in comment 9.
I have NOT tried to wrap any longer lines. Not sure what I did the last time - but did not want to replicate it again.
Hope this is at least a better start on this issue.
Grant

jhodgdon’s picture

Status: Needs review » Needs work

Thanks! This is looking much better.

I think a few spots can be improved a bit... and the wrapping will need to be fixed in the spots that are updated in this patch, but I can take care of that when I commit the patch, so don't worry about it for now:

  1. +++ b/source/en/install-prepare.txt
    @@ -19,9 +19,9 @@ pre-requisites.
     that provides you with an automated installation, or you can choose to install
    -Drupal yourself on your own computer or server. If you install it yourself, you
    +your site yourself on your own computer or server. If you install it yourself, you
    

    I think in this case, instead of "your site" it should say "the software"?

  2. +++ b/source/en/install-prepare.txt
    @@ -54,13 +54,13 @@ http://www.drush.org/en/master[Drush Documentation].
    -. Download Drupal core or the Drupal distribution you would like to use.
    +. Download the core software or the Drupal distribution you would like to use.
    

    Let's take out the second word "drupal" in this line too?

  3. +++ b/source/en/install-requirements.txt
    @@ -38,14 +38,14 @@ media, backups and other files.
    -  Apache is the most commonly used web server for Drupal. Drupal will
    +  Apache is the most commonly used web server for the core software. Drupal will
    

    I think here we can just take out "for Drupal".

    And maybe for the second Drupal in this line, we should replace it with "the core software"?

  4. +++ b/source/en/planning-modular.txt
    @@ -40,7 +40,7 @@ submitted.
    -it is automatically displayed on the vendor page. In Drupal specifically, the
    +it is automatically displayed on the vendor page. In the core software specifically, the
    

    Hm. Here... maybe we should just take out the whole "In Drupal specifically," part?

  5. +++ b/source/en/preface-audience.txt
    @@ -14,7 +14,7 @@ Drupal. If you need to learn more about Drupal before deciding, see
    -knowledge are assumed, and the guide concentrates on Drupal itself. For
    +knowledge are assumed, and the guide concentrates on the core software itself. For
    

    How about "... the guide concentrates on how to use the software" maybe?

  6. +++ b/source/en/preface-audience.txt
    @@ -14,7 +14,7 @@ Drupal. If you need to learn more about Drupal before deciding, see
     instance, the sections about installing Drupal on a web server assume you can
    

    I think we can get rid of Drupal in this line too?

  7. +++ b/source/en/preface-conventions.txt
    @@ -67,7 +67,7 @@ In the _Manage_ administrative menu, navigate to
    +Navigation instructions like this assume that you have the Toolbar
    

    should say "core Toolbar module"

  8. +++ b/source/en/security-update-core.txt
    @@ -116,7 +116,7 @@ $settings['update_free_access'] = FALSE;
    -verify the current version of your drupal site, navigate to _Reports > Status
    +verify the current version of your site, navigate to _Reports > Status
    

    current version of your software (not site)?

  9. +++ b/source/en/thoughts-learn-more.txt
    @@ -22,11 +22,11 @@
    -  basic to advanced, about all aspects of Drupal (site building and
    +  basic to advanced, about all aspects of the core software (site building and
    

    Hm. This is talking about drupal.org/documentation -- it has a lot of documentation about core, but also about contributed stuff... I think maybe this is an example of where we should leave the word Drupal in there, since it is a description of what you'll find on drupal.org?

  10. +++ b/source/en/understanding-drupal.txt
    @@ -51,7 +51,7 @@ Drupal can also run on other technology stacks:
    +however, the scripts that the core software uses are written in PHP, so that cannot be
    

    let's take out the word "core" here. Not only the core software is PHP, but also contributed modules etc.

  11. +++ b/source/en/understanding-project.txt
    @@ -30,8 +30,8 @@ purpose.
     The community encompasses many smaller groups who perform many different tasks
     such as developing a particular piece of Drupal-related software, writing
    -documentation, maintaining the security of Drupal software, translating Drupal
    -software into a particular language, using Drupal for some specific purpose,
    +documentation, maintaining the security of the core software, translating Drupal
    +software into a particular language, using the core software for some specific purpose,
     and coming together to meet in person within a particular geographical area.
    

    This paragraph is about the Drupal community. I think we can just leave the Drupal word in there.

gdunham’s picture

Status: Needs work » Needs review
StatusFileSize
new21.63 KB

Agree. Those spots are much better with your suggestions.
I've made those changes. (And I think I've figured out how to wrap lines now - so have done that for these suggestions only. Earlier changes have been left - to make it easier to roll back if I've made another mistake. If the word wrapping is OK, I'll do that in the future.)
Grant

  • jhodgdon committed 0214d39 on 8.x-0.x
    Issue #2698981 by gdunham, ifrik, jhodgdon, eojthebrave: Copy edit:...
jhodgdon’s picture

Thanks! The wording all looks great to me now. A few notes on wrapping for the next time:

  1. +++ b/source/en/content-paths.txt
    @@ -35,12 +35,12 @@ Here are some examples of paths you might find in a Drupal site:
    +The core software has a feature called "URL Alias" that allows you to provide ¶
    +a more understandable name to the content. So, if you have an "About Us" page ¶
    +with the path _node/7_, you can set up an alias so that your visitors will see ¶
    +it as _http://www.example.com/AboutUs_. As far as browsers, servers, and ¶
    +search engines go, it is totally unnecessary. But for humans, it is nearly ¶
    +mandatory. This is why most consultants tell people to always turn on the Path ¶
    

    We don't want spaces at the ends of lines, so when rewrapping, remove the end-of-line spaces.

  2. +++ b/source/en/install-prepare.txt
    @@ -31,10 +31,10 @@ Free online options::
    +Install the core software at your hosting provider::
    +  If you choose to install the core software at your hosting provider, your ¶
    +hosting provider may have specific documentation and/or a one-click install ¶
    +that you can use.
    

    In this case, the wrapping is not quite right. This is a :: list, and (at least in my understanding) these three lines all need to be indented by a couple of spaces to get the formatting right.

So I committed this patch, thanks! I'll add another comment shortly...

jhodgdon’s picture

Status: Needs review » Needs work

After applying/committing this patch, I used grep to see where we are still using the word Drupal... I think we should fix a few more spots before we close this issue out:

a) content-paths.txt:
In Drupal terms, a path is the unique, last part of the URL for a specific

b) extend-module-find.txt:
|Core compatibility |The Drupal version the module is compatible with.|8.x

c) Quite a few spots in glossary.txt

d) install-prepare.txt:
(((Installing,Drupal)))
(((Drush tool,using to install Drupal)))
(((Web installer,using to install Drupal)))

Note: these are index entries. Don't rewrap. Later in that file:

Use an online provider to get a demo installation of Drupal in 20 minutes or

e) Quite a few spots in install-requirements.txt

f) install-run.txt
Install Drupal and create the admin account by running the included installer.

g) menu-concept.txt:
Drupal standard profile installation contains five menus:

h) planning-workflow.txt
In Drupal, content types can have either a Published or an Unpublished flag to

i) prevent-log.txt:
image:images/prevent-log.png["Recent log messages of a Drupal site",width="100%"]

j) prevent-status.txt:
image:images/prevent-status.png["Status report of a Drupal site",width="100%"]

k) Numerous places in security-update-core.txt ... we should probably change the title of this topic to "Updating the Core Software" instead of "Updating Drupal Core", right?

l) structure-content-type.txt:
| Promoted to front page | In a default Drupal website this setting can be used to show content on the homepage. In your website you will not use this option. | Unchecked
| Sticky at the top of the list | In a default Drupal website this setting can be used to keep content on top of a list. In your website you will not use this option. | Unchecked

m) structure-image-responsive.txt:
Drupal's "Responsive Image" module provides responsive image styles. This allows

gdunham’s picture

Status: Needs work » Needs review
StatusFileSize
new14.95 KB

I've gone through the files suggested and made changes. The glossary.txt should be reviewed carefully. I did not make as many changes as maybe I should. I am not familiar with what some of the special character enclosures mean and was reluctant to make changes. Please advise.
Grant

jhodgdon’s picture

Status: Needs review » Needs work

Pretty good! I have a few wording suggestions and some wrapping/spacing suggestions:

  1. I took a closer look at the glossary. I think the change you've made there is the only change that needs to be made, actually. Thanks!
  2. +++ b/source/en/content-paths.txt
    @@ -21,9 +21,9 @@ content on the web.
    +In terms of the core software, a path is the unique, last part of the URL for a
    

    Maybe we should just take out "In terms of the core software" here. I think when we have a "What is a ..." topic, it is probably understood to be in the context of Drupal.

  3. +++ b/source/en/glossary.txt
    @@ -191,7 +191,7 @@
    +   Acronym for Linux, Apache, MySQL, and PHP: the software that the software
        commonly runs on (although it can use other operating systems, web
    

    Hm.

    "the software that the software commonly runs on"... ... not too great.

    What can we do?

    Maybe:

    The software needed on the web server for the scripts to run

    or something like that?

  4. +++ b/source/en/install-prepare.txt
    @@ -27,8 +27,9 @@ install it yourself, you can use Drush or the web installer.
     Free online options::
    -  Use an online provider to get a demo installation of Drupal in 20 minutes or
    -  less. See the https://www.drupal.org/try-drupal[Drupal.org page "Try Drupal"].
    +  Use an online provider to get a demo installation of the core software in 20
    + minutes or less. See the https://www.drupal.org/try-drupal[Drupal.org page
    + "Try Drupal"].
    

    The two last lines here need to be indented by 2 spaces (definition list).

  5. +++ b/source/en/install-requirements.txt
    @@ -7,8 +7,8 @@
    +(((Installing,the core software)))
    +(((The core software installation,requirements)))
    

    These are index entries. I don't think they should have "the" in them.

  6. +++ b/source/en/install-requirements.txt
    @@ -57,9 +57,9 @@ Hiawatha::
    +  7 if PHP is configured correctly. Because clean URLs are required, you may
    + need to use a third party product. For IIS 7 you can use the Microsoft URL
    + Rewrite Module or a third party solution.
    

    lines need indenting (in a definition list)

  7. +++ b/source/en/install-run.txt
    @@ -10,7 +10,8 @@
    +Install the core software and create the admin account by running the included
    + installer.
    

    The second line here should not be indented.

  8. +++ b/source/en/planning-workflow.txt
    @@ -22,8 +22,9 @@ collect information and write content, editors review, edit, ask for changes,
    +In your site, content types can have either a Published or an Unpublished flag
    + to track their workflow states, that you can set for each content item when
    + saving:
    

    Second and third lines here should not be indented.

  9. +++ b/source/en/security-update-core.txt
    @@ -1,15 +1,15 @@
    +(((The core software,updating)))
    

    Index entry, should not start with "the".

  10. +++ b/source/en/security-update-core.txt
    @@ -1,15 +1,15 @@
    +Update the core software, either through the administrative interface or by
    + using Drush.
    

    second line should not be indented.

  11. +++ b/source/en/security-update-core.txt
    @@ -132,8 +131,8 @@ messages, we recommend you to follow the instructions on the
    +You may also refer _/core/UPGRADE.txt_ within your installation in case you
    + want to learn more about updating the core software.
    

    no indent

  12. +++ b/source/en/structure-image-responsive.txt
    @@ -15,10 +15,10 @@
    +The "Responsive Image" module provides responsive image styles. This allows
    + you to have images in your website that are specifically sized for different
    + screen Sizes. This is useful, for example, to make your site load faster on
    + mobile devices because image sizes are optimized for smaller screens.
    

    no indent on subsequent lines.

    Also at the start of this, let's say:

    The core Responsive Image module ...

    (no quotes, add word "core")

gdunham’s picture

Status: Needs work » Needs review
StatusFileSize
new14.8 KB

I've made the changes suggested above.
Thanks
Grant

jhodgdon’s picture

Status: Needs review » Fixed

Looks good, thanks! I fixed a few indentation and wrapping things, and committed this. I think this issue is done. Wonderful!

  • jhodgdon committed efa916a on 8.x-0.x
    Issue #2698981 by gdunham: Copy edit: Avoid using the word Drupal
    

Status: Fixed » Closed (fixed)

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