Comments

ifrik created an issue. See original summary.

ifrik’s picture

Title: Cop edit two references pages » Copy edit two references pages
jhodgdon’s picture

Issue summary: View changes

Fixing issue summary...

ifrik’s picture

Assigned: ifrik » Unassigned
Status: Active » Needs review
StatusFileSize
new6.4 KB

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

ifrik’s picture

StatusFileSize
new3.16 KB
new1.31 KB

I forgot to upload the txt files themselves as well.

jhodgdon’s picture

Status: Needs review » Needs work

Thanks! 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:

  1. +++ b/source/en/config-basic.txt
    @@ -27,26 +27,26 @@ _Default time zone_, and so on.
    +Refer to this screeshot for the steps below.
    

    Typo: screeshot -> screenshot

  2. +++ b/source/en/config-basic.txt
    @@ -62,12 +62,12 @@ Here are some sample values you could fill in:
    +. After editing the fields, click ¶
    

    Extra space added at the end of this line.

  3. +++ b/source/en/config-basic.txt
    @@ -62,12 +62,12 @@ Here are some sample values you could fill in:
    +Refer to this screeshot for the steps below.
    

    Typo: screeshot -> screenshot

  4. +++ b/source/en/config-basic.txt
    @@ -76,24 +76,24 @@ image:images/config-basic-TimeZone.png["Time Zones",width="100%"]
    +. Choose the appropriate country from the _Default country_ drop down in the
     'Locale' section.
    

    Guideline:

    For a drop-down list or radio button, say “Select (choice)”.

  5. +++ b/source/en/config-basic.txt
    @@ -76,24 +76,24 @@ image:images/config-basic-TimeZone.png["Time Zones",width="100%"]
    +. In the _Time zones_ section is a drop down with which you can change
     the sitewide _Default time zone_.
    

    Same guideline as previous.

  6. +++ b/source/en/config-basic.txt
    @@ -76,24 +76,24 @@ image:images/config-basic-TimeZone.png["Time Zones",width="100%"]
    +. After editing the fields, click ¶
    

    extra space at end of this line

  7. +++ b/source/en/understanding-distributions.txt
    @@ -12,23 +12,24 @@
    +'Distributions' provide site features and functions for a specific type of site
    

    Distributions should be in italics

    _Distributions_

    not single quotes. Guideline: when introducing new terminology for the first time, put the term in italic typeface...

  8. +++ b/source/en/understanding-distributions.txt
    @@ -12,23 +12,24 @@
    +  Disttributions can also be quick-start tools that developers and site
    

    Typo: Disttributions -> Distributions

  9. in source/en/config-basic.txt ===== Configuring the basic site information
    
    Refer to this screeshot for the steps below.
     
    // To create this image, install Drupal 8, navigate to
    // admin/config/system/site-information and take the screenshot.
    image:images/config-basic-SiteInfo.png["Site Information",width="100%"]
    

    Probably this screenshot should go after the navigation step (which is how you get to see the page).

  10. in source/en/config-basic.txt ===== Configuring the basic site information
    
    _Site information_ (admin/config/system/site-information) to configure basic
    settings, such as the _Site name_, _Slogan_, _Email address_, or the
    _Default front page_ path.
    

    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.

  11. in source/en/config-basic.txt  ===== Configuring the basic site information
    
    . The very first thing which you may like to change is the site name: You can
    enter the desired name of the site in the _Site name_ field (in the
    _Site details_ section).
     
    . The site slogan can be edited by entering the desired text in the _Slogan_
    field.
     
    . The site's administrative email address (which is used as the 'From'
    address in automated email communications, such as registrations, password
    resets, etc) can be entered in the _Email address_ field.
    

    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?

  12. in source/en/config-basic.txt ===== Configuring the country and time zone
    
    Refer to this screeshot for the steps below.
     
    // To create this image, install Drupal 8, navigate to
    // admin/config/regional/settings and take the screenshot.
    image:images/config-basic-TimeZone.png["Time Zones",width="100%"]
    

    Probably this screenshot should go after the navigation step.

  13. in source/en/config-basic.txt ===== Configuring the country and time zone
    
    . Choose the appropriate country from the _Default country_ drop down in the
    'Locale' section.
     
    . You can also change the _First day of week_ for your region.
     
    . In the _Time zones_ section is a drop down with which you can change
    the sitewide _Default time zone_.
    

    These three steps would be better as a table of fields and values.

  14. in understanding-distributions ==== What are Distributions?
    
      A 'full-featured' distribution is an all-inclusive project that provides a
    

    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?

ifrik’s picture

Thanks,
I've taken the comments into account, and I hope I got the formatting right this time.

ifrik’s picture

Status: Needs work » Needs review
jhodgdon’s picture

MUCH better, thanks! A few more notes on config-basic -- understanding-distributions looks great:

  1. +
    Here are some sample values you could fill in:
    

    Let's make this a separate step. Something like:

    Fill in the following fields:

  2. |Email address|Sitewide email address to be displayed|info@example.com
    

    I don't think the email address is really "displayed"? Maybe needs a different explanation of what it is used for?

  3. Also, please provide attribution information for how you'd like your work to be credited for editing these two pages. Something like:
    https://www.drupal.org/u/ifrik[Your displayed name here] of
    http://example.com[name of the organization or company that sponsored the work]
    
jhodgdon’s picture

Status: Needs review » Needs work
ifrik’s picture

Status: Needs work » Needs review
StatusFileSize
new9.09 KB
new20.2 KB
new2.7 KB

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

jhodgdon’s picture

Status: Needs review » Fixed

Looks great! Committed to the guide. Thanks!

  • jhodgdon committed a7b7aa9 on 8.x-0.x authored by ifrik
    Issue #2699005 by ifrik: Copy edit two references pages
    

Status: Fixed » Closed (fixed)

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