aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1
diff options
context:
space:
mode:
authorNik Clayton <nik@FreeBSD.org>1999-07-14 19:25:40 +0000
committerNik Clayton <nik@FreeBSD.org>1999-07-14 19:25:40 +0000
commit17da18f046bbb3a1f4b4c299f4ae61040aa4d8eb (patch)
tree5d0eda072c8037746408a93380a9021fa152c4df /en_US.ISO8859-1
parent68640ce6ccff36d2667efe7b3ea9ad318f7d8d5f (diff)
downloaddoc-17da18f046bbb3a1f4b4c299f4ae61040aa4d8eb.tar.gz
doc-17da18f046bbb3a1f4b4c299f4ae61040aa4d8eb.zip
Rewritten a lot. Clearer in some places, more explicit in others (no,
that does not mean "Get your XXX pics here"). Added $Id$.
Notes
Notes: svn path=/head/; revision=5215
Diffstat (limited to 'en_US.ISO8859-1')
-rw-r--r--en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml152
1 files changed, 121 insertions, 31 deletions
diff --git a/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml
index 84fef1dc71..1322c34a6f 100644
--- a/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml
+++ b/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml
@@ -26,54 +26,144 @@
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
+
+ $Id: chapter.sgml,v 1.2 1999-07-14 19:25:40 nik Exp $
-->
<chapter id="overview">
<title>Overview</title>
- <para>Welcome to the FreeBSD Documentation Project, and thank you for
- volunteering. One of the keys to the success of a project such as FreeBSD
- is the availability of good quality documentation, and your contribution
- will help that success.</para>
+ <para>Welcome to the FreeBSD Documentation Project. Good quality
+ documentation is very important to the success of FreeBSD, and the
+ FreeBSD Documentation Project (FDP) is how a lot of that documentation
+ is produced. Your contributions are very valuable.</para>
+
+ <para>This document's main purpose is to clearly explain <emphasis>how
+ the FDP is organised</emphasis>, <emphasis>how to write and submit
+ documentation to the FDP</emphasis>, and <emphasis>how to
+ effectively use the tools available to you when writing
+ documentation</emphasis>.</para>
- <para>After you have read this primer you should;</para>
+ <para>Every one is welcome to join the FDP. There is no minimum
+ membership requirements, no quota of documentation you need to
+ produce per month. All you need to do is subscribe to the
+ <email>freebsd-doc@freebsd.org</email> mailing list.</para>
+
+ <para>After you have finished reading this document you should:</para>
<itemizedlist>
- <listitem>
- <para>Have an understanding of the text formats used by the
- Documentation Project, and why they were chosen.</para>
+ <listitem>
+ <para>Know which documentation is maintained by the FDP.</para>
</listitem>
<listitem>
- <para>Be able to read and understand the source code for the Handbook,
- FAQ, and website, and follow how they are converted into HTML,
- PostScript, and other formats.</para>
+ <para>Be able to read and understand the SGML source code for the
+ documentation maintained by the FDP.</para>
</listitem>
- <listitem>
- <para>Be able to make changes to the documentation, test them, and
- either contribute them back to the project or (if you have commit
- privileges) commit them.</para>
+ <listitem>
+ <para>Be able to make changes to the documentation.</para>
</listitem>
- </itemizedlist>
-
- <para>This primer assumes that you already understand;</para>
-
- <itemizedlist>
- <listitem>
- <para>How to maintain an up-to-date copy of the FreeBSD CVS tree using
- CVS and one of CVSup or CTM, and how to check out particular versions
- of files.</para>
-
- <para>Alternatively, how to retrieve versions of files using the
- <application>CVSWeb</application> interface.</para>
- </listitem>
<listitem>
- <para>How to use the ports system to download and install new
- software.</para>
- </listitem>
+ <para>Be able to submit your changes back for review and eventual
+ inclusion in the FreeBSD documentation.</para>
+ </listitem>
</itemizedlist>
+
+ <sect1>
+ <title>The FreeBSD Documentation Set</title>
+
+ <para>The FDP is responsible for four categories of FreeBSD
+ documentation.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>Manual pages</term>
+
+ <listitem>
+ <para>The English language system manual pages are not written by
+ the FDP, as they are part of the base system. However, the FDP can
+ (and has) re-worded parts of existing manual pages to make them
+ clearer, or to correct inaccuracies.</para>
+
+ <para>The translation teams are responsible for translating the
+ system manual pages in to different languages. These translations
+ are kept within the FDP.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>FAQ</term>
+
+ <listitem>
+ <para>The FAQ aims to address (in short question and answer format)
+ questions that are asked, or should be asked, on the various
+ mailing lists and newsgroups devoted to FreeBSD. The format does
+ not permit long and comprehensive answers.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Handbook</term>
+
+ <listitem>
+ <para>The Handbook aims to be the comprehensive on-line resource and
+ reference for FreeBSD users.</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Web site</term>
+
+ <listitem>
+ <para>This is the main FreeBSD presence on the World Wide Web,
+ visible at <ulink
+ url="http://www.freebsd.org/">http://www.freebsd.org/</ulink>
+ and many mirrors around the world. The web site is many people's
+ first exposure to FreeBSD.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>These four groups of documentation are all available in the
+ FreeBSD CVS tree. This means that the logs and changes to these
+ files are visible to anyone, and anyone can use a program such as
+ <application>CVSup</application> or
+ <application>CTM</application> to keep their own local copies of
+ this documentation.</para>
+
+ <para>In addition, many people have written tutorials or other web
+ sites relating to FreeBSD. Some of these are stored in the CVS
+ repository as well (where the author has agreed to this). In
+ other cases the author has decided to keep their documentation
+ separate from the main FreeBSD repository. The FDP endeavours to
+ provide links to as much of this documentation as
+ possible.</para>
+ </sect1>
+
+ <sect1>
+ <title>Before you start</title>
+
+ <para>This document assumes that you already know:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>How to maintain an up-to-date local copy of the FreeBSD
+ documentation. Either by maintaining a local copy of the
+ FreeBSD CVS repository (using <application>CVS</application>
+ and either <application>CVSup</application> or
+ <application>CTM</application>) or by using
+ <application>CVSup</application> to download just a
+ <emphasis>checked-out</emphasis> copy.</para>
+ </listitem>
+
+ <listitem>
+ <para>How to download and install new software using either the
+ FreeBSD Ports system or &man.pkg.add.1;.</para>
+ </listitem>
+ </itemizedlist>
+ </sect1>
</chapter>
<!--