From nobody@FreeBSD.org  Thu Dec 13 16:21:12 2001
Return-Path: <nobody@FreeBSD.org>
Received: from freefall.freebsd.org (freefall.FreeBSD.org [216.136.204.21])
	by hub.freebsd.org (Postfix) with ESMTP id 21F1B37B405
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 13 Dec 2001 16:21:12 -0800 (PST)
Received: (from nobody@localhost)
	by freefall.freebsd.org (8.11.6/8.11.6) id fBE0LCH00161;
	Thu, 13 Dec 2001 16:21:12 -0800 (PST)
	(envelope-from nobody)
Message-Id: <200112140021.fBE0LCH00161@freefall.freebsd.org>
Date: Thu, 13 Dec 2001 16:21:12 -0800 (PST)
From: Hiten Pandya <hiten@uk.FreeBSD.org>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [PATCH] - Formal Text for /docproj/who.html
X-Send-Pr-Version: www-1.0

>Number:         32818
>Category:       docs
>Synopsis:       [PATCH] - Formal Text for /docproj/who.html
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Thu Dec 13 16:30:01 PST 2001
>Closed-Date:    Fri Jan 11 16:51:06 PST 2002
>Last-Modified:  Fri Jan 11 16:52:03 PST 2002
>Originator:     Hiten Pandya
>Release:        5.0-CURRENT
>Organization:
>Environment:
FreeBSD hpdi.ath.cx 5.0-CURRENT FreeBSD 5.0-CURRENT #1: Wed Dec 12 00:34:45 GMT 2001     hitenp@hpdi.ath.cx:/usr/obj/data/dev/src/sys/CURRENT5  i386

>Description:
the patch i have attached will replace some of the informal, and
sloppy (sorry bout my bluntness) bits of http://www.FreeBSD.org/docproj/who.html
with more formal text and better stucture.  The reason for this is very
obvious; translaters will find it easy to translate.

If you like the patch, submit it, dont like it? comment on it. :-)


>How-To-Repeat:
n/a / visit http://www.FreeBSD.org/docproj/who.html
>Fix:
*** who.sgml.old        Thu Dec 13 23:34:07 2001
--- who.sgml    Thu Dec 13 23:47:14 2001
***************
*** 13,25 ****
        <a href="mailto:FreeBSD-doc@FreeBSD.ORG">FreeBSD-doc@FreeBSD.ORG</a>.</p>
  
      <p>Some of us can commit changes directly to the FreeBSD documentation
!       tree. The complete list of people with commit ``privs'' is in <a
!       href="../handbook/staff-doc.html">the
!       Handbook</a>.</p>
      
!     <p>Others do not have commit privs, but they write and <a
!       href="submitting.html">submit documentation</a> nonetheless. One of the
!       committers will then include it in the documentation set.</p>
      
      <p>If you want to help out with the documentation project (and I fervently
        hope you do) all you have to do is subscribe to the mailing list and
--- 13,27 ----
        <a href="mailto:FreeBSD-doc@FreeBSD.ORG">FreeBSD-doc@FreeBSD.ORG</a>.</p>
  
      <p>Some of us can commit changes directly to the FreeBSD documentation
!       tree. The complete list of people with commit ``privileges'' can be 
!       found in the <a href="../handbook/staff-doc.html">Handbook</a>.</p>
      
!     <p>The general public  does not have commit privilges, but they write and 
!     <b>submit documentation</b> nonetheless. Once the documenation has been 
!     submitted according to the procedure layed out on the 
!     <a href="submitting.html"><b>Submitting Documentation</b></a> page, it will
!     be noticed by one of the committers and will be reviewed &amp; committed.
!     </p>
      
      <p>If you want to help out with the documentation project (and I fervently
        hope you do) all you have to do is subscribe to the mailing list and
***************
*** 27,32 ****
        project.</p>
  
        <p></p><a href="docproj.html">FreeBSD Documentation Project Home</a>
! &footer
    </body>
  </html>
--- 29,34 ----
        project.</p>
  
        <p></p><a href="docproj.html">FreeBSD Documentation Project Home</a>
!    &footer;
    </body>
  </html>

>Release-Note:
>Audit-Trail:

From: Andrew McKay <andy@openirc.co.uk>
To: Hiten Pandya <hiten@uk.FreeBSD.org>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/32818: [PATCH] - Formal Text for /docproj/who.html
Date: Fri, 14 Dec 2001 11:53:06 +0000 (GMT)

 On Thu, 13 Dec 2001, Hiten Pandya wrote:
 
 HP> >Severity:       serious
 HP> >Priority:       high
 
 How do you justify this classification?  Just wondering.  To me a
 serious/high-priority change is one where the documentation may be
 misleading enough to cause a user to damage their system or render it
 unbootable.
 
 HP> If you like the patch, submit it, dont like it? comment on it. :-)
 
 Comments below:
 
 HP>       <p>Some of us can commit changes directly to the FreeBSD documentation
 HP> !       tree. The complete list of people with commit ``privileges'' can be 
 HP> !       found in the <a href="../handbook/staff-doc.html">Handbook</a>.</p>
 
 I'd be inclined to lose the ``'' around privileges.  To my mind they
 exist around privs to indicate that it is a slang term.
 
 HP> !     <p>The general public  does not have commit privilges, but they write and 
 HP> !     <b>submit documentation</b> nonetheless. Once the documenation has been 
 HP> !     submitted according to the procedure layed out on the 
 HP> !     <a href="submitting.html"><b>Submitting Documentation</b></a> page, it will
 HP> !     be noticed by one of the committers and will be reviewed &amp; committed.
 HP> !     </p>
 
 I would phrase this as:
 
  <p>Members of the project who do not have commit privileges can
  contribute by <b>submitting documentation</b>.  Details of how to do this
  are available on the <a href="submitting.html"><b>Submitting
  Documentation</b></a> page.  Once the submission is received it will be
  reviewed &amp; committed as appropriate.</p>
 
 Not sure about the need for <b> tags in there but they won't hurt, I
 guess.
 
 Just my comments, as per your request.
 
 -- 
 Andrew McKay <andy@openirc.co.uk>
 
 
 

From: Ceri <setantae@submonkey.net>
To: Hiten Pandya <hiten@uk.FreeBSD.org>
Cc: freebsd-gnats-submit@freebsd.org
Subject: Re: docs/32818: [PATCH] - Formal Text for /docproj/who.html
Date: Fri, 14 Dec 2001 18:55:40 +0000

 > If you like the patch, submit it, dont like it? comment on it. :-)
 
 Comments below, as requested.
 
 > !       tree. The complete list of people with commit ``privileges'' can be 
 
 As someone else pointed out, priviliges isn't slang or an abbreviation.
 Best to lose the quotes altogether I feel.
 
 > !     <p>The general public  does not have commit privilges, but they write and 
 > !     <b>submit documentation</b> nonetheless. Once the documenation has been 
 
 ``The general public'' is either singular, or it's plural. Not both.
 
 You have also spelt documentation incorrectly. Time to install ispell ? ;)
 
 > !     submitted according to the procedure layed out on the 
 
 s/layed/laid/
 
 > !     be noticed by one of the committers and will be reviewed &amp; committed.
 
 What's wrong with ``and'' instead of ``&amp;'' ?
 
 Ceri
 
 -- 
 keep a mild groove on
State-Changed-From-To: open->closed 
State-Changed-By: bmah 
State-Changed-When: Fri Jan 11 16:51:06 PST 2002 
State-Changed-Why:  
Fixed the issues with the patch, plus fixed a bunch of other 
problems on this page.  The changes should show up within the next 
24 hours.  Thanks for the submission! 

http://www.FreeBSD.org/cgi/query-pr.cgi?pr=32818 
>Unformatted:
