os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Shorten the quick start a little more by factoring out repeated references

Browse source 
to the mailing list, make some corrections in wording and directories.
This commit is contained in:
Warren Block 2013-07-22 21:23:03 +00:00
parent b21d5be678
commit 3c0732cf97
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=42385
1 changed files with 13 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

37
en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml
View file

@ -137,22 +137,14 @@
<title>Quick Start</title>
<para>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 <acronym>XML</acronym> and the suggestions in
<xref linkend="writing-style-guide"/>. 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.</para>
documentation. First, subscribe to the &a.doc;.
Some team members also interact on the
<literal>#bsddocs</literal>
<acronym>IRC</acronym> channel on
<ulink url="http://www.efnet.org/">EFnet</ulink>. These people
can help with questions or problems involving the documentation.</para>
<procedure>
<step>
<para>Subscribe to the &a.doc;. Some mailing list members
also interact on the <literal>#bsddocs</literal>
<acronym>IRC</acronym> channel on <ulink
url="http://www.efnet.org/">EFnet</ulink>.</para>
</step>
<step>
<para>Install the
<filename role="package">textproc/docproj</filename>
@ -162,11 +154,10 @@
<step>
<para>Install a local working copy of the documentation
from a mirror of the &os; repository (see
<xref linkend="working-copy"/>) in
<filename class="directory">~/doc</filename>.</para>
from a mirror of the &os; repository in
<filename class="directory">~/doc</filename> (see <xref linkend="working-copy"/>).</para>
<screen>&prompt.user; <userinput>svn checkout https://<replaceable>svn0.us-west.FreeBSD.org</replaceable>/doc/head <replaceable>/usr/doc</replaceable></userinput></screen>
<screen>&prompt.user; <userinput>svn checkout https://<replaceable>svn0.us-west.FreeBSD.org</replaceable>/doc/head <replaceable>~/doc</replaceable></userinput></screen>
</step>
<step>
@ -194,12 +185,12 @@
<step>
<para>Update the local working copy:</para>
<screen>&prompt.user; <userinput>svn up ~/doc</userinput></screen>
<screen>&prompt.user; <userinput>svn up <replaceable>~/doc</replaceable></userinput></screen>
</step>
<step>
<para>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.</para>
<para>References to tag and entity usage can be found in
@ -214,9 +205,7 @@
<para>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;.</para>
problems. Repeat until all of the errors are resolved.</para>
</step>
<step>
@ -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
<acronym>HTML</acronym>, type <command>make</command> in the
<acronym>HTML</acronym>, run <command>make</command> in the
<filename>en_US.ISO8859-1/books/handbook/</filename>
directory.</para>
</step>