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

Task for this issue

When testing the User Guide, testers found some problems with the Views chapter. So, we need to edit the following topics:

views-create.txt (Creating a Content List View)
  1. In step 2, in the table of fields and values, after "Show", we need to insert another row to tell the reader to also select "Vendor" in the "of type" field. (This is shown in the screen shot, but was omitted from the table.)
  2. In step 6, it should say to check (not select) "Main Image" (not "Image"). In Step 7 it should also say "Main image" instead of "Image".
views-duplicate.txt (Duplicating a View)
  1. In step 4: The pre-existing format is Format: Table, not Format: Unformatted. The instructions are also unclear (it needs to clearly say to click "Table" next to "Format", in order to change it). Also, the instructions are unclear about the two separate dialog boxes that will show up. So, this step needs some rewriting.
  2. Step 8: Add a table of fields, explanations, and values (currently you would need to use the screenshot to figure out what to enter).
  3. Step 9: Add instruction to click Apply at the end of this step.
  4. Step 10: The first sentence needs to be rewritten -- "roll out" is not a clear instruction. It should instead say something like "Click _Advanced_ to expand the _Advanced_ section of the configuration."
  5. Step 11: "clicking on Save of the Displays panel." is unclear. It is not really in the Displays panel. Probably should just say "click the Save button".

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? If only one or a few topics were edited, you can instead attach the updated source file(s).
- Is the edit complete and correct?
- Is the work free from additional edits outside the scope of the provided guidelines or task?
- Is attribution provided? See https://userguide_new-drupal.dev.devdrupal.org/guidelines/guidelines.htm...

CommentFileSizeAuthor
#5 user_guide-fix_views_chapter-2717545-5.patch4.03 KBjojyja
#3 user_guide-fix_views_chapter-2717545-3.patch4.23 KBjojyja
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon created an issue. See original summary.

jojyja’s picture

jojyja CreditAttribution: jojyja at Red Crackle commented
Assigned: Unassigned » jojyja

I will work on this edit.

jojyja’s picture

jojyja CreditAttribution: jojyja at Red Crackle commented
Assigned: jojyja » Unassigned
Status: Active » Needs review
FileSize
user_guide-fix_views_chapter-2717545-3.patch4.23 KB

Hi! Here is the patch.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Needs work

Thanks! This is mostly very good. A few things to fix:

  1. views-duplicate step for: Take out "for now" in "Retain the default values for now". That will just be kind of confusing, because we won't be telling them to change them later.
  2. +++ b/source/en/views-duplicate.txt
@@ -68,23 +66,32 @@ image:images/views-duplicate_filter.png["Add ingredients filter",width="100%"]
+| Filter type to expose | Provide a filter for refined results | Single filter/Grouped filters

    I'm a bit confused by this one. I don't understand the explanation -- it doesn't seem to tell me what the difference is between single and grouped values. And I think the example value should be "Single filter".

    But... Making group filters is a rather complicated, advanced topic. Maybe we should just leave this line out of the table rather than trying to explain it? In other topics, we don't include every single field that appears on the screen in the table, just the ones we want to explain and maybe change, so I think it is OK to leave this out. 

  3. +++ b/source/en/views-duplicate.txt
@@ -68,23 +66,32 @@ image:images/views-duplicate_filter.png["Add ingredients filter",width="100%"]
+| Required field | Whether the field is required or not | Unchecked

    I think in the explanation column we should say something like "Whether a value has to be provided or not". It's not really a "field" (even though the Views UI uses the word "field"). 

  4. +++ b/source/en/views-duplicate.txt
@@ -68,23 +66,32 @@ image:images/views-duplicate_filter.png["Add ingredients filter",width="100%"]
+| Label | Label that is visible in the content form | Find recipes using...

    This isn't a content form, it is a Views page. So maybe "Label shown for this filter on the view page" or something like that? 

  5. +++ b/source/en/views-duplicate.txt
@@ -68,23 +66,32 @@ image:images/views-duplicate_filter.png["Add ingredients filter",width="100%"]
+| Description | Explain the use of the filter | This filter helps visitors refine recipe searches

    I really don't think we should put a description in here. It would appear on the Recipes page, and I don't think it is necessary (or even a good idea)? Let's just leave this line out of the table. 

  6. +++ b/source/en/views-duplicate.txt
@@ -68,23 +66,32 @@ image:images/views-duplicate_filter.png["Add ingredients filter",width="100%"]
+. Click _Save_ to ensure the updates are made.

    We don't really want to use the word "ensure" in the guide (there's another issue about that). Just say to click Save, or you can say something like "Click Save to save the view".

jojyja’s picture

jojyja CreditAttribution: jojyja at Red Crackle commented
Status: Needs work » Needs review
FileSize
user_guide-fix_views_chapter-2717545-5.patch4.03 KB

Thank you for the detailed feedback! I have created another patch.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Fixed

Great, thanks! Committed this patch to the guide (with a few word-wrapping fixes). Used your attribution from the previous issue.

  • jhodgdon committed 349a667 on 8.x-0.x authored by jojyja 
    Issue #2717545 by jojyja: Content edit: Fix up the Views chapter

Status: Fixed » Closed (fixed)

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