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

Add a "Quick Start" section, based on one of my messages to -doc.

Browse source
This commit is contained in:
Nik Clayton 2001-07-16 14:45:56 +00:00
parent 213a66a8d3
commit b30b3464f5
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=9920
1 changed files with 94 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

96
en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml
View file

@ -27,7 +27,7 @@
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
$FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/overview/chapter.sgml,v 1.5 2000/07/07 18:38:23 dannyboy Exp $
$FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml,v 1.6 2001/04/17 16:16:18 nik Exp $
-->
<chapter id="overview">
@ -166,7 +166,99 @@ Every one is welcome to join the FDP. There is no minimum
FreeBSD Ports system or &man.pkg.add.1;.</para>
</listitem>
</itemizedlist>
</sect1>
</sect1>
<sect1>
<title>Quick Start</title>
<para>If you just want to get going, and feel confident you can pick
things up as you go along, follow these instructions.</para>
<procedure>
<step>
<para>Install the <filename>textproc/docproj</filename>
meta-port.</para>
<screen>&prompt.root; <userinput>cd /usr/ports/textproc/docproj</userinput>
&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
</step>
<step>
<para>Get a local copy of the FreeBSD <filename>doc</filename> tree.
Either use CVSup in <literal>checkout</literal> mode to do this, or
get a full copy of the CVS repository locally.</para>
<para>If you have the CVS repository locally then as a minimum you
will need to checkout the <filename>doc/share</filename>, and
<filename>doc/en_US.ISO8859-1/share</filename>
directories.</para>
<screen>&prompt.user; <userinput>cvs checkout doc/share</userinput>
&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/share</userinput></screen>
<para>If you have plenty of disk space then you could check out
everything.</para>
<screen>&prompt.user; <userinput>cvs checkout doc</userinput></screen>
</step>
<step>
<para>If you are preparing a change to an existing book or article,
check it out of the repository as necessary. If you are planning on
contributing a new book or article then use an existing one as a
guide.</para>
<para>For example, if you want to contribute a new article about
setting up a VPN between FreeBSD and Windows 2000 you might do the
following.</para>
<procedure>
<step>
<para>Check out the <filename>articles</filename>
directory.</para>
<screen>&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/articles</userinput></screen>
</step>
<step>
<para>Copy an existing article to use as a template. In this
case, you have decided that your new article belongs in a
directory called <filename>vpn-w2k</filename>.</para>
<screen>&prompt.user; <userinput>cd doc/en_US.ISO8859-1/articles</userinput>
&prompt.user; <userinput>cp -r committers-guide vpn-w2k</userinput></screen>
</step>
</procedure>
<para>If you wanted to edit an existing document, such as the the FAQ,
which is in <filename>doc/en_US.ISO8859-1/books/faq</filename> you
would check it out of the repository like this.</para>
<screen>&prompt.user; <userinput>cvs checkout doc/en_US.ISO8859-1/books/faq</userinput></screen>
</step>
<step>
<para>Edit the <filename>.sgml</filename> files using your editor of
choice.</para>
</step>
<step>
<para>Test the markup using the <maketarget>lint</maketarget> target,
and convert the document to other formats for review.</para>
<screen>&prompt.user; <userinput>make lint</userinput>
&prompt.user; <userinput>make FORMAT=<replaceable>format</replaceable></userinput></screen>
<para>Where <replaceable>format</replaceable> is one of
<literal>html</literal>, <literal>html-split</literal>,
<literal>txt</literal>, or <literal>rtf</literal></para>
</step>
<step>
<para>Submit your changes using &man.send-pr.1;.</para>
</step>
</procedure>
</sect1>
</chapter>
<!--