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

Comments

ifrik created an issue. See original summary.

ifrik’s picture

Assigned: Unassigned » ifrik
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).

ifrik’s picture

Status: Active » Needs review
Issue tags: +#drupalbcdays
StatusFileSize
new20.98 KB

I'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.

ifrik’s picture

Issue tags: -#drupalbcdays +DrupalBCDays
batigolix’s picture

Status: Needs review » Needs work

I reviewed the patch & found a couple of things that need fixing

  1. +++ b/source/en/config-overview.txt
    @@ -6,12 +6,10 @@
    +Use the administrative menu and contextual links to access administration pages ¶
    

    trailing space?

  2. +++ b/source/en/config-overview.txt
    @@ -6,12 +6,10 @@
    +and to edit forms and content.
    
    +++ b/source/en/content-create.txt
    @@ -8,7 +8,7 @@
    +Create and publish a page with content.
    

    Or "Create and publish content"?

  3. +++ b/source/en/language-add.txt
    @@ -6,8 +6,7 @@
    +Add one or more languages to your site and set which on is used by default.
    

    "Set which on" --> "Set which one". Although I have a light preference for "define" over "set" ...

  4. +++ b/source/en/language-content-config.txt
    @@ -6,9 +6,7 @@
    +Make the Custom block, Custom menu links and Basic page content type translatable and set which fields of these can be translated.
    

    Line runs over 80 chars.

    Typo: translatatable

  5. +++ b/source/en/language-enable.txt
    @@ -6,14 +6,8 @@
    +Install multilingual modules through the administrative interface or using Drush.
    

    Runs over 80 chars

  6. +++ b/source/en/planning-layout.txt
    @@ -82,4 +84,4 @@ home page.
    \ No newline at end of file
    

    Removed the last newline in the file?

  7. +++ b/source/en/structure-adding-reference.txt
    @@ -11,7 +11,7 @@
    +Add a reference field so that recipes can be linked to the vendor has
    

    "that" missing after "vendor"

  8. +++ b/source/en/structure-form-editing.txt
    @@ -6,11 +6,7 @@
    +Change the _Recipe_ form to use a different widget to enter terms in the _Ingredients_ field.
    

    runs over 80 chars

  9. +++ b/source/en/structure-taxonomy-setup.txt
    @@ -6,11 +6,7 @@
    +Create an _Ingredients_ vocabulary and add it to the _Recipe_ content type as a field that can contain an unlimited number of values and that allows adding new terms to the vocabulary.
    

    runs over 80 chars

  10. +++ b/source/en/user-permissions.txt
    @@ -9,13 +9,7 @@
    +Change the permissions for the _Vendor_ role so that users can create, edit, and delete recipe and vendor content, format the content, and contact each other.
    

    runs over 80 chars

  11. +++ b/source/en/views-block.txt
    @@ -6,10 +6,7 @@
    +Add a block display to the _Recipes_ views that can be displayed in a sidebar and change its configuration without changing the existing recipes page view.
    

    80 chars

  12. +++ b/source/en/views-duplicate.txt
    @@ -6,10 +6,7 @@
    +Create a page with all recipes by duplicating the existing _Vendors_ view and modify it so that the recipes are displayed in a grid and can by filtered by ingredients.
    

    80 chars

ifrik’s picture

Status: Needs work » Needs review
StatusFileSize
new20.99 KB
new5.6 KB

Thanks,

I fixed a lot of line lengths...

I only left (2) because contextual links can't be used to create new content.

jhodgdon’s picture

Status: Needs review » Needs work

Thanks for the patches and reviews! This is mostly excellent. I have a few suggestions:

  1. +++ b/source/en/config-overview.txt
    @@ -6,12 +6,10 @@
    +==== Goal
    

    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.

  2. +++ b/source/en/config-theme.txt
    @@ -6,9 +6,7 @@
    -The goal of this task is to edit the settings of the default Bartik theme to
    -update "Color scheme" and insert a logo of your choice. For this example, we
    -will be using the visual guidelines for our farmers market site.
    +Edit the settings of the default Bartik theme.
    

    We could still say "to update the color schema and add a logo"?

  3. +++ b/source/en/content-create.txt
    @@ -8,7 +8,7 @@
    -Creating a content item.
    +Create and publish a page with content.
    

    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)

  4. +++ b/source/en/extend-maintenance.txt
    @@ -7,9 +7,8 @@
    +Put your site in maintenance mode to prevent visitors from adding or editing
    +content and from getting error messages while the update scripts runs.
    

    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.

  5. +++ b/source/en/extend-module-install.txt
    @@ -9,10 +9,8 @@
    +Download and install the contributed module _Admin toolbar_ which allows you to
    

    ... the contributed Admin Toolbar module...

    (that will get the mention of the module in line with our standards)

    Also needs , before which

  6. +++ b/source/en/install-prepare.txt
    @@ -4,9 +4,8 @@
    +Choose an appropriate way to install Drupal and handle any required
    +pre-requisites.
    

    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"?

  7. +++ b/source/en/security-update-core.txt
    @@ -6,16 +6,10 @@
    +patch (Drupal 8.0.0-beta13 to Drupal 8.0.0-beta14 - latest version at the
    +time of writing this document), either using the administrative interface or
    

    Let's take out the stuff about patches and beta versions. That is all in the past at this point.

  8. +++ b/source/en/views-block.txt
    @@ -6,10 +6,8 @@
    -We want to show the most recent recipes on the site in a sideblock. Rather than
    -creating an entirely new view for it, we add a Block display to the already
    -existing Recipes view. Then we change the configuration, for this new display
    -only.
    +Add a block display to the _Recipes_ views that can be displayed in a sidebar
    +and change its configuration without changing the existing recipes page view.
    

    We lost the information that the block view's purpose is to display the most recent recipes.

ifrik’s picture

Status: Needs work » Needs review
StatusFileSize
new19.59 KB
new3.74 KB

Thanks, 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.

  • jhodgdon committed d0e7285 on 8.x-0.x authored by ifrik
    Issue #2699033 by ifrik, jhodgdon, batigolix: Copy edit: Goal section
    
jhodgdon’s picture

Status: Needs review » Fixed

Wow, this is great! I saw a few typos here and there, but we can fix them during copy editing.

Fixed this on commit:

+++ b/source/en/config-theme.txt
@@ -6,9 +6,7 @@
+Edit the settings of the default Bartik theme to change the color scheme and to add a logo.

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

jhodgdon’s picture

Status: Fixed » Active

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

jhodgdon’s picture

Issue summary: View changes

Standardizing 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?

ifrik’s picture

Assigned: ifrik » Unassigned

Sorry, I'm currently overwhelmed with issues. If somebody else can take this up, that would be great.

jhodgdon’s picture

Assigned: Unassigned » jhodgdon

I'll take on the last 3 topics for this issue.

jhodgdon’s picture

Status: Active » Needs review
StatusFileSize
new6.95 KB

Here's a patch, including attributions, for the 3 remaining topics.

jhodgdon’s picture

StatusFileSize
new6.64 KB

Rerolling patch. Took out the site-wide editing attributions notice too.

eojthebrave’s picture

Status: Needs review » Needs work
+++ b/source/en/config-uninstall.txt
@@ -9,11 +9,8 @@
-Leaving the modules installed that are unused by your application (in our
-case, modules such as _Comment_, _History_, and _Search_) adds an overhead to
-the site performance. Thus, it is important to identify such modules and
-uninstall them. In this guide, you will learn how to uninstall such modules

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

jhodgdon’s picture

Status: Needs work » Needs review
StatusFileSize
new6.67 KB

Here'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:

Each module that is installed adds to the time needed to generate pages on your site, so it is a good idea to uninstall modules that are not needed.

I just don't think we should put information like this into the Goal sections of topics... what do you think?

eojthebrave’s picture

Status: Needs review » Fixed

Knowing that the concept is covered elsewhere totally works for me. I just wanted to make sure that we didn't lose it.

I just don't think we should put information like this into the Goal sections of topics... what do you think?

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!

Status: Fixed » Closed (fixed)

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