Copy editing guideline for this issue

Every list should be preceded by either a header or a colon ( : ).
List items that are sentences end in period ( . ); list items that are not sentences do not end in period ( . ).

Task Instructions

  1. To claim this task, assign this issue to yourself (see instructions below). Only claim a task if you can complete it in about two weeks.
  2. See the instructions below to "clone" the guide, edit the entire user guide so that it follows the above copy editing guideline, and make a patch file. Do not make other edits at this time -- other edits will be taken care of in other issues. If you find that you cannot complete the whole task, but have made some progress, make a patch file for the part you've done.
  3. Upload the patch file to this issue, in the Files section.
  4. Set the Issue Status to Needs Review, in the Issue Metadata section.
  5. Write a comment stating what you've done.
  6. In this comment, add "Attribution" information
    https://www.drupal.org/u/msmith[Mary Smith]
    or
    https://www.drupal.org/u/jsmith[Joe Smith] of https://example.com[Example Company]
    
  7. Someone will review your work, and either accept it, or set it back to Needs Work for more attention.
  8. If the status is set to Needs Work, make the requested changes, make a new patch file, and upload it. Iterate until it is fixed.

Detailed Instructions for Assigning Issues and Patching

Assigning an issue to yourself

  1. Scroll to the bottom of the issue to Add new comment.
  2. Open the "Issue metadata" section if it is collapsed.
  3. Put your user name in the "Assigned" field, add a short comment stating that you are claiming the task, and Save.

Editing and making a patch file

  1. In order to make a patch file, you will need to use the Git version control software. There are generic instructions on Git at: https://www.drupal.org/documentation/git/ -- if you have never used Git, you will probably want to read the introductory material, and you'll need to install Git.
  2. Specific Git instructions for the User Guide project can be found at https://www.drupal.org/project/user_guide/git-instructions . Follow the instructions to "clone" the repository (see the "One-time only" instructions).
  3. Make the edits for this issue, using a plain-text editor. The source files are located in the source/en subdirectory, and have extension .txt, and are in AsciiDoc format (see below).
  4. Go back to the specific Git instructions page and follow the instructions there to make a patch file. There are also more detailed git patch instructions in the Git documentation section linked above.

AsciiDoc formatting

The documentation in this project is formatted using AsciiDoc. The Formatting page in the User Guide guidelines (login: drupal / drupal ) has links and details for how to format text properly, make cross-links between topics, etc.

CommentFileSizeAuthor
#4 2699069-4.patch5.7 KBbatigolix
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

ifrik created an issue. See original summary.

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

batigolix’s picture

Assigned: Unassigned » batigolix

giving it a shot

batigolix’s picture

Status: Active » Needs review
FileSize
5.7 KB

Maybe I'm overllloking stuff but I didnt find a lot of issues with item lists.

See the patch

  • jhodgdon committed 46fffd8 on 8.x-0.x authored by batigolix
    Issue #2699069 by batigolix: Copy edit: Lists and list items
    
jhodgdon’s picture

Status: Needs review » Fixed

I didn't think there were too many issues. That is good.

The patch looks fine to me! One note:

+++ b/source/en/preface-conventions.txt
@@ -3,6 +3,8 @@
 ==== Assumptions and prerequisites
 
+This guide has the following assumptions and prerequisites:
+
 * This guide is organized into topics; see <<preface-organization>> for details.

It is OK not to have a "line ending in :" here, because it is preceded by a header. However, I agree in this case it may make things clearer.

So, I applied the patch and committed it. Thanks!

Status: Fixed » Closed (fixed)

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