From owner-svn-doc-all@FreeBSD.ORG Mon Jul 22 21:23:04 2013 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id E590498E; Mon, 22 Jul 2013 21:23:03 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id D5B9D259C; Mon, 22 Jul 2013 21:23:03 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r6MLN3HL025285; Mon, 22 Jul 2013 21:23:03 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r6MLN3gf025284; Mon, 22 Jul 2013 21:23:03 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201307222123.r6MLN3gf025284@svn.freebsd.org> From: Warren Block Date: Mon, 22 Jul 2013 21:23:03 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42385 - head/en_US.ISO8859-1/books/fdp-primer/overview X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 22 Jul 2013 21:23:04 -0000 Author: wblock Date: Mon Jul 22 21:23:03 2013 New Revision: 42385 URL: http://svnweb.freebsd.org/changeset/doc/42385 Log: Shorten the quick start a little more by factoring out repeated references to the mailing list, make some corrections in wording and directories. Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Mon Jul 22 21:08:56 2013 (r42384) +++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Mon Jul 22 21:23:03 2013 (r42385) @@ -137,23 +137,15 @@ Quick Start Some preparatory steps must be taken before editing the &os; - documentation. New contributors will interact with other - members of the &os; Documentation Team, which can assist in - learning to use XML and the suggestions in - . If a new user - contributes regularly, a Documentation Team member may be - assigned as a mentor to guide the user through the process from - contributor to documentation committer. + documentation. First, subscribe to the &a.doc;. + Some team members also interact on the + #bsddocs + IRC channel on + EFnet. These people + can help with questions or problems involving the documentation. - Subscribe to the &a.doc;. Some mailing list members - also interact on the #bsddocs - IRC channel on EFnet. - - - Install the textproc/docproj package or port. This meta-port installs all of the @@ -162,11 +154,10 @@ Install a local working copy of the documentation - from a mirror of the &os; repository (see - ) in - ~/doc. + from a mirror of the &os; repository in + ~/doc (see ). - &prompt.user; svn checkout https://svn0.us-west.FreeBSD.org/doc/head /usr/doc + &prompt.user; svn checkout https://svn0.us-west.FreeBSD.org/doc/head ~/doc @@ -194,12 +185,12 @@ Update the local working copy: - &prompt.user; svn up ~/doc + &prompt.user; svn up ~/doc Edit the documentation files that require changes. If a - file needs major changes, consult the &a.doc; for + file needs major changes, consult the mailing list for input. References to tag and entity usage can be found in @@ -214,9 +205,7 @@ Review the output and edit the file to fix any problems shown, then rerun the command to find any remaining - problems. Repeat until all of the errors that are fixable - are resolved. If an error seems unsolvable, ask for - assistance on the &a.doc;. + problems. Repeat until all of the errors are resolved. @@ -225,7 +214,7 @@ top-level directory of the documentation being edited will generate that documentation in split HTML format. For example, to build the English version of the Handbook in - HTML, type make in the + HTML, run make in the en_US.ISO8859-1/books/handbook/ directory.