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):
Make sure that the Goal section in task topics is expressed as a specific goal for the site, not as the learning goal or something generic.
- For instance it should be "Add a content type for vendors to the site" not "Learn how to add a content type to the site" or “Add a content type”.
- Also it should not start with “The goal ...”, but should start with a verb.
At this point, there are only 3 topics that still need work for this issue:
- config-uninstall.txt
- config-user.txt
- structure-text-format-config.txt ... This topic has a very large Goal section. Some of its content may need to be moved to the companion concept: structure-text-formats.txt instead, if it is not already there.
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 |
|---|---|---|---|
| #19 | 2699033-three-topics-19.patch | 6.67 KB | jhodgdon |
Comments
Comment #2
ifrikComment #3
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 #4
ifrikI've gone through all task pages and edited the Goal where appropriate.
In some cases long texts were written under goal with content that is probably rather for a concept page. In these case I moved the content into the steps section as that needs to be edited anyway.
Comment #5
ifrikComment #6
batigolixI reviewed the patch & found a couple of things that need fixing
trailing space?
Or "Create and publish content"?
"Set which on" --> "Set which one". Although I have a light preference for "define" over "set" ...
Line runs over 80 chars.
Typo: translatatable
Runs over 80 chars
Removed the last newline in the file?
"that" missing after "vendor"
runs over 80 chars
runs over 80 chars
runs over 80 chars
80 chars
80 chars
Comment #7
ifrikThanks,
I fixed a lot of line lengths...
I only left (2) because contextual links can't be used to create new content.
Comment #8
jhodgdonThanks for the patches and reviews! This is mostly excellent. I have a few suggestions:
This topic is a concept, not a task. It should not have a goal section at all.
The stuff at the top of this topic should probably just be removed.
We could still say "to update the color schema and add a logo"?
What kind of a page would not have "content" on it?
How about:
Create and publish a content item that will be used as the home page of the site.
(this is even more specific)
This is not really accurate. We should have fixed this in the original topic writing.
Maintenance mode does not prevent people from editing/adding content at all, really.
What it actually does is prevent anyone who is not logged in with a role that has a certain permission (something like "Use the site in maintenance mode") from doing anything at all on the site, including even viewing the normal site pages. And instead it presents them with a message that you can edit to say that the site is under maintenance.
... the contributed Admin Toolbar module...
(that will get the mention of the module in line with our standards)
Also needs , before which
The way this is written, I read it as "choose how to install" and "choose how to handle prerequisites".
Maybe put a comma before "and" to hopefully make it clearer that you are "choosing" how to install and "handling" prerequisites"?
Let's take out the stuff about patches and beta versions. That is all in the past at this point.
We lost the information that the block view's purpose is to display the most recent recipes.
Comment #9
ifrikThanks, those proposals solve points where I also wasn't quite sure.
I've rerolled the patch and then taken up the points raised in #8.
Comment #11
jhodgdonWow, this is great! I saw a few typos here and there, but we can fix them during copy editing.
Fixed this on commit:
This line needed wrapping to 80 characters.
And there was one hunk that failed due to other patches being applied by other copy editors, so I had to do that manually. Anyway, took care of this, and the patch in #9 has been applied.
Thanks!
I went through the guide... see next comment coming shortly...
Comment #12
jhodgdonI browsed through all of the Task topics in the guide, and I there are three more that still need editing:
- config-uninstall.txt
- config-user.txt
- structure-text-format-config.txt ... This topic has a very large Goal section. Some of its content may need to be moved to the companion concept: structure-text-formats.txt instead, if it is not already tehre.
Comment #13
jhodgdonStandardizing issue summaries for the editing issues.
@ifrik: Do you still plan to work on this, or should we unassign it so that someone else can do the last 3 topics?
Comment #14
ifrikSorry, I'm currently overwhelmed with issues. If somebody else can take this up, that would be great.
Comment #15
jhodgdonI'll take on the last 3 topics for this issue.
Comment #16
jhodgdonHere's a patch, including attributions, for the 3 remaining topics.
Comment #17
jhodgdonRerolling patch. Took out the site-wide editing attributions notice too.
Comment #18
eojthebraveThe information about uninstalling un-used modules being an important thing to do is lost if we remove it from this goal. I just checked, and it's not really covered elsewhere in this topic.
Do you think it's worth writing a sentence or two about this in the body of the topic if it's not in the goal? Most of the other topics that are titled something generic like, "Install a module" or "Change site-wide configuration" don't really specify why we're choosing a specific module to install or configuration to change. So maybe this isn't necessary here either? I just want to make sure we're not loosing important data.
Comment #19
jhodgdonHere's an updated patch (another reroll, since the config-uninstall topic was recently changed in another issue).
Regarding #18, I think the right thing to do is to put the information about site overhead of modules into the Modules concept topic, since it's concept information. This is already a prerequisite of this topic... and actually, the Concept: Modules topic already says:
I just don't think we should put information like this into the Goal sections of topics... what do you think?
Comment #21
eojthebraveKnowing that the concept is covered elsewhere totally works for me. I just wanted to make sure that we didn't lose it.
I agree with this, which is why I kind of argued with myself a little in my previous comment. Task topics should stick to "Here's what you're going to do, and here's how to do it." And concepts can cover the more hand-wavy stuff.
Thanks for finishing this up. I just committed the latest patch and I think we can go ahead and close this now. Woohoo!