From owner-svn-doc-head@FreeBSD.ORG Thu Aug 7 12:56:37 2014 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id 9E7632EF for ; Thu, 7 Aug 2014 12:56:37 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1 with cipher ECDHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 7929D2511 for ; Thu, 7 Aug 2014 12:56:37 +0000 (UTC) Received: from gavin (uid 1136) (envelope-from gavin@FreeBSD.org) id 50fc by svn.freebsd.org (DragonFly Mail Agent v0.9+); Thu, 07 Aug 2014 12:56:37 +0000 From: Gavin Atkinson Date: Thu, 7 Aug 2014 12:56:37 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r45415 - head/en_US.ISO8859-1/htdocs/docproj X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Message-Id: <53e37785.50fc.708f06ef@svn.freebsd.org> X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 07 Aug 2014 12:56:37 -0000 Author: gavin Date: Thu Aug 7 12:56:37 2014 New Revision: 45415 URL: http://svnweb.freebsd.org/changeset/doc/45415 Log: Update the "How do I submit documentation changes" for Bugzilla, and more generally for the 21st century. Modified: head/en_US.ISO8859-1/htdocs/docproj/submitting.xml Modified: head/en_US.ISO8859-1/htdocs/docproj/submitting.xml ============================================================================== --- head/en_US.ISO8859-1/htdocs/docproj/submitting.xml Thu Aug 7 10:32:54 2014 (r45414) +++ head/en_US.ISO8859-1/htdocs/docproj/submitting.xml Thu Aug 7 12:56:37 2014 (r45415) @@ -19,53 +19,29 @@

First, thank you for taking the time to do this.

You should make your documentation available for review. If you can, - put it on an FTP site or a website.

+ upload it to a website somewhere.

Then post a message to the FreeBSD-doc mailing list, with a brief outline of the documentation and the pointer to its location, and solicit feedback.

-

If, for some reason, you cannot put the documentation up for FTP or on +

If, for some reason, you cannot put the documentation on a website somewhere you can send it directly to the FreeBSD-doc mailing list. If you do this, please only send plain-text documents.

-

You should probably cc: this request for comments to other appropriate - mailing lists. For example, something that relates to how to use SVN to +

You may wish to cc: this request for comments to another appropriate + mailing list. For example, something that relates to how to use SVN to keep your source tree up to date would be of interest to the subscribers - of the FreeBSD-current and FreeBSD-stable mailing - lists.

+ of the FreeBSD-stable mailing list. Please only cc: at most + one other mailing list.

After people have looked over your documentation, and you have had the chance to incorporate any of their suggestions, you are ready to submit it.

-

To do this, wrap it up into a tar file. If your documentation consists - of three files, one, two, and three, and you want it - all to go into doc.tar, do

- - 
-    % tar cf doc.tar one two three
-
- -

which does just that. Then compress the tar file,

- - 
-    % gzip -9 doc.tar
-
- -

which will produce doc.tar.gz.

- -

Finally, encode the file so that it will not be mangled by any email - programs.

- - 
-    % uuencode doc.tar.gz doc.tar.gz > doc.uue
-
- -

You should then let the Documentation Project know about it. The - correct way to do this is to use a command called send-pr, which - should be installed on your machine. - The WWW problem report form may also be used.

+

The correct way to do this is to open a Problem Report. Instructions + for doing this can be found at + https://www.FreeBSD.org/support/bugreports.html.

You do this so that your submission can be tracked. When you submit a PR (Problem Report) it is assigned a unique number. One of the committers @@ -74,20 +50,11 @@ For more information, see Writing FreeBSD Problem Reports.

-

send-pr itself is pretty simple. All it does is send an email - with some special formatting to a particular address. When you run - send-pr you will be put into your editor (probably vi or - emacs) with a template to fill out, and some instructions on how - to fill it out.

- -

Make sure the "Category" is set to "docs" and that the "Class" is set - to one of "change-request". You should include the .uue file - you created earlier in the body of the PR.

- -

When you come out of the editor the PR will be sent as an email to the - right place. You will get a notification message shortly afterwards - telling you what number your PR has been given, and this number can - be used to track its progress.

+

Make sure the "Product" is set to "Documentation" and that the + "Component" is set to either "Documentation" or "Website" as + appropriate. You should attach your files from earlier to the PR. + Please also provide links to the mailing list posts where your changes + were discussed, if appropriate.

I have made some changes to existing documentation, how do I submit them?

@@ -131,7 +98,7 @@

You can then send foo.diff back to the project. Send a PR as - described earlier, but include the foo.diff file in the body of the + described earlier, and attach the foo.diff file to the PR.

FreeBSD Documentation Project Home