Bug 32818

Summary: [PATCH] - Formal Text for /docproj/who.html
Product: Documentation Reporter: Hiten Pandya <hiten>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Hiten Pandya 2001-12-14 00:30:01 UTC 
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
Comment 1 Andrew McKay 2001-12-14 11:53:06 UTC 
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>
Comment 2 setantae 2001-12-14 18:55:40 UTC 
> 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
Comment 3 Bruce A. Mah freebsd_committer freebsd_triage 2002-01-12 00:51:06 UTC 
State Changed
From-To: open->closed

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!