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...
| Comment | File | Size | Author |
|---|---|---|---|
| #20 | 2509156.patch | 14.8 KB | gdunham |
| #18 | 2509156.patch | 14.95 KB | gdunham |
| #14 | 2509156.patch | 21.63 KB | gdunham |
| #12 | 2509156.patch | 19.09 KB | gdunham |
| #10 | 2509156.patch | 41.9 KB | gdunham |
Comments
Comment #2
ifrikI'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.
Comment #3
ifrikFixed the somewhat confusing patch name.
Comment #4
ifrikI'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.
Comment #5
jhodgdonI'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).
Comment #6
gdunham commentedI will work on this one.
Comment #7
jhodgdonStandardizing issue summaries for the editing issues.
Comment #8
gdunham commentedHere 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]
Comment #9
eojthebraveI'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!
Looks like "Drupal" got removed, but an extra "your" got added.
This looks like it needs to be re-wrapped to 80 characters after adding the changes.
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.
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.
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.
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.
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.
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"
Same here, I think we can just say, "Every view mode can be configured through the administration pages."
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.
Lets leave this one as "drupal" since we're talking specifically about connecting with the Drupal community here.
Comment #10
gdunham commentedI'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.)
Comment #11
jhodgdonI 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!
Comment #12
gdunham commentedI'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
Comment #13
jhodgdonThanks! 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:
I think in this case, instead of "your site" it should say "the software"?
Let's take out the second word "drupal" in this line too?
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"?
Hm. Here... maybe we should just take out the whole "In Drupal specifically," part?
How about "... the guide concentrates on how to use the software" maybe?
I think we can get rid of Drupal in this line too?
should say "core Toolbar module"
current version of your software (not site)?
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?
let's take out the word "core" here. Not only the core software is PHP, but also contributed modules etc.
This paragraph is about the Drupal community. I think we can just leave the Drupal word in there.
Comment #14
gdunham commentedAgree. 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
Comment #16
jhodgdonThanks! The wording all looks great to me now. A few notes on wrapping for the next time:
We don't want spaces at the ends of lines, so when rewrapping, remove the end-of-line spaces.
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...
Comment #17
jhodgdonAfter 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
Comment #18
gdunham commentedI'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
Comment #19
jhodgdonPretty good! I have a few wording suggestions and some wrapping/spacing suggestions:
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.
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?
The two last lines here need to be indented by 2 spaces (definition list).
These are index entries. I don't think they should have "the" in them.
lines need indenting (in a definition list)
The second line here should not be indented.
Second and third lines here should not be indented.
Index entry, should not start with "the".
second line should not be indented.
no indent
no indent on subsequent lines.
Also at the start of this, let's say:
The core Responsive Image module ...
(no quotes, add word "core")
Comment #20
gdunham commentedI've made the changes suggested above.
Thanks
Grant
Comment #21
jhodgdonLooks good, thanks! I fixed a few indentation and wrapping things, and committed this. I think this issue is done. Wonderful!