Copy editing guideline for this issue

In the text of the guide, use "website" instead of "web site".

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
#6 [description]-[issue-number]-[comment-number].patch11.73 KBgdunham

Comments

ifrik created an issue. See original summary.

ifrik’s picture

ifrik
she/her
commented
Status: Needs review » Active
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Issue summary: View changes
gdunham’s picture

gdunham commented
Assigned: Unassigned » gdunham

I'll try this. May have some questions about git. But should be good.
Grant

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Thanks for taking this on! I just wanted to alert you that I just made updates to a few files in the guide (we had a couple more pages to write and/or edit for the first draft). So you may want to do:

git stash
git pull
git stash apply

if you have already started working on this, or just

git pull

if you have already "cloned" and "pulled" the Git repository but haven't edited any files yet.

gdunham’s picture

gdunham commented
Status: Active » Needs review
StatusFileSize
new [description]-[issue-number]-[comment-number].patch11.73 KB

I've made the changes so all references are to website(s).
"Attribution" information https://www.drupal.org/u/gdunham[Grant Dunham]
Hope this is acceptable. If it is, I'll take a few more.

ifrik’s picture

ifrik
she/her
commented
Status: Needs review » Reviewed & tested by the community

Thanks gdunham,

just a practical remark first: in future you should replace the placeholders in the patch name with the actual description, issue and comment number, so that it's obvious what the patch is for.

For the rest it looks fine.
There is no instance of "web site" or "web sites" left in the the source/en directory.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Fixed 
+++ b/source/en/preface-audience.txt
@@ -13,8 +13,7 @@ background knowledge to understand this guide: general Internet skills and
-Similarly, the sections about content management assume you can log into a web
-site and fill in a web-based form.
+Similarly, the sections about content management assume you can log into a website and fill in a web-based form.

For the next time, we're trying to keep the source file to max 80 character lines (with a couple of exceptions, like keeping image tags and link tags inline without a break).

I'll take care of this on commit though, not a problem.

Anyway, thanks for taking care of this gdunham, and thanks ifrik for reviewing! Committed to the guide.

And I agree with ifrik about the patch file name. You can also just name it something like 2699001.patch (with 2699001 in this case being the issue number). Or if it's a subsequent patch, 2699001-12.patch (with 12 being the comment number within the issue). But really, the patch name is not too important, as long as it is a good patch.

Thanks!

  • jhodgdon committed f746bc1 on 8.x-0.x authored by gdunham 
    Issue #2699001 by gdunham: Copy edit: website instead of web site

Status: Fixed » Closed (fixed)

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