Problem/Motivation
Some pages should be completely copy edited so that they can serve as references on how the pages should look like in the end. This is separate from the per-issue copy editing.
Proposed resolution
These two pages need to edited:
- https://userguide_new-drupal.dev.devdrupal.org/d8guide/en/understanding-...
- https://userguide_new-drupal.dev.devdrupal.org/d8guide/en/config-basic.html
according to the guidelines set out on https://docs.google.com/document/d/15LFjn9Nx-8VeuEIx_SrWpQE_kQxzEb_UgmL4...
| Comment | File | Size | Author |
|---|---|---|---|
| #11 | config-basic.txt | 2.7 KB | ifrik |
| #11 | attributions.txt | 20.2 KB | ifrik |
| #11 | 2699005-user_guide-copy-edited-reference-pages-11.patch | 9.09 KB | ifrik |
| #7 | understanding-distributions.txt | 1.3 KB | ifrik |
| #7 | config-basic.txt | 2.61 KB | ifrik |
Comments
Comment #2
ifrikComment #3
jhodgdonFixing issue summary...
Comment #4
ifrikI've edited the two pages according to the guidelines set out it the document.
In config-basic.txt I'm tempted to make the text more concise, but I'm not sure how far to go with that.
Comment #5
ifrikI forgot to upload the txt files themselves as well.
Comment #6
jhodgdonThanks! This is looking pretty good. YES, config-basic definitely can be made more concise. Please do as much as you can on that!
So, I took a look at the patch as well as the text files. There are a few things that I think still can be improved:
Typo: screeshot -> screenshot
Extra space added at the end of this line.
Typo: screeshot -> screenshot
Guideline:
For a drop-down list or radio button, say “Select (choice)”.
Same guideline as previous.
extra space at end of this line
Distributions should be in italics
_Distributions_
not single quotes. Guideline: when introducing new terminology for the first time, put the term in italic typeface...
Typo: Disttributions -> Distributions
Probably this screenshot should go after the navigation step (which is how you get to see the page).
It seems like the part that says "to configure basic settings..." can be removed from this sentence. We are already in a section about "Configuring the basic site information", and the following steps make it clear what you can configure.
These three steps would be better as a table of fields and values. Maybe combine them with the table that is currently there about the 403/404 pages?
Probably this screenshot should go after the navigation step.
These three steps would be better as a table of fields and values.
We shouldn't be using single quotes at all. Either use double quotes or italics here... probably italics as it is kind of a "new terminology" situation?
Comment #7
ifrikThanks,
I've taken the comments into account, and I hope I got the formatting right this time.
Comment #8
ifrikComment #9
jhodgdonMUCH better, thanks! A few more notes on config-basic -- understanding-distributions looks great:
Let's make this a separate step. Something like:
Fill in the following fields:
I don't think the email address is really "displayed"? Maybe needs a different explanation of what it is used for?
Comment #10
jhodgdonComment #11
ifrikI've used the information about the email address from the original text in the table now, and then edited the other two explanations as well for consistency.
I've also added myself to attributions.txt
Comment #12
jhodgdonLooks great! Committed to the guide. Thanks!