Shorten the quick start a little more by factoring out repeated references
to the mailing list, make some corrections in wording and directories.
This commit is contained in:
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
|
|
@ -137,22 +137,14 @@
|
||||||
<title>Quick Start</title>
|
<title>Quick Start</title>
|
||||||
|
|
||||||
<para>Some preparatory steps must be taken before editing the &os;
|
<para>Some preparatory steps must be taken before editing the &os;
|
||||||
documentation. New contributors will interact with other
|
documentation. First, subscribe to the &a.doc;.
|
||||||
members of the &os; Documentation Team, which can assist in
|
Some team members also interact on the
|
||||||
learning to use <acronym>XML</acronym> and the suggestions in
|
<literal>#bsddocs</literal>
|
||||||
<xref linkend="writing-style-guide"/>. If a new user
|
<acronym>IRC</acronym> channel on
|
||||||
contributes regularly, a Documentation Team member may be
|
<ulink url="http://www.efnet.org/">EFnet</ulink>. These people
|
||||||
assigned as a mentor to guide the user through the process from
|
can help with questions or problems involving the documentation.</para>
|
||||||
contributor to documentation committer.</para>
|
|
||||||
|
|
||||||
<procedure>
|
<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>
|
<step>
|
||||||
<para>Install the
|
<para>Install the
|
||||||
<filename role="package">textproc/docproj</filename>
|
<filename role="package">textproc/docproj</filename>
|
||||||
|
|
@ -162,11 +154,10 @@
|
||||||
|
|
||||||
<step>
|
<step>
|
||||||
<para>Install a local working copy of the documentation
|
<para>Install a local working copy of the documentation
|
||||||
from a mirror of the &os; repository (see
|
from a mirror of the &os; repository in
|
||||||
<xref linkend="working-copy"/>) in
|
<filename class="directory">~/doc</filename> (see <xref linkend="working-copy"/>).</para>
|
||||||
<filename class="directory">~/doc</filename>.</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>
|
||||||
|
|
||||||
<step>
|
<step>
|
||||||
|
|
@ -194,12 +185,12 @@
|
||||||
<step>
|
<step>
|
||||||
<para>Update the local working copy:</para>
|
<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>
|
||||||
|
|
||||||
<step>
|
<step>
|
||||||
<para>Edit the documentation files that require changes. If a
|
<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>
|
input.</para>
|
||||||
|
|
||||||
<para>References to tag and entity usage can be found in
|
<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
|
<para>Review the output and edit the file to fix any problems
|
||||||
shown, then rerun the command to find any remaining
|
shown, then rerun the command to find any remaining
|
||||||
problems. Repeat until all of the errors that are fixable
|
problems. Repeat until all of the errors are resolved.</para>
|
||||||
are resolved. If an error seems unsolvable, ask for
|
|
||||||
assistance on the &a.doc;.</para>
|
|
||||||
</step>
|
</step>
|
||||||
|
|
||||||
<step>
|
<step>
|
||||||
|
|
@ -225,7 +214,7 @@
|
||||||
top-level directory of the documentation being edited will
|
top-level directory of the documentation being edited will
|
||||||
generate that documentation in split HTML format. For
|
generate that documentation in split HTML format. For
|
||||||
example, to build the English version of the Handbook in
|
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>
|
<filename>en_US.ISO8859-1/books/handbook/</filename>
|
||||||
directory.</para>
|
directory.</para>
|
||||||
</step>
|
</step>
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue