Date: Fri, 10 Jun 2016 23:10:09 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r48912 - head/en_US.ISO8859-1/books/fdp-primer/overview Message-ID: <201606102310.u5ANA9rG034265@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Fri Jun 10 23:10:09 2016 New Revision: 48912 URL: https://svnweb.freebsd.org/changeset/doc/48912 Log: Swap The FreeBSD Documentation Set and the Quick Start sections in the Overview chapter, making the Quick Start section the first thing that eager new documentation contributors see. From BSDCan 2016 Doc Lounge. 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 Fri Jun 10 22:47:24 2016 (r48911) +++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Fri Jun 10 23:10:09 2016 (r48912) @@ -68,73 +68,6 @@ </listitem> </itemizedlist> - <sect1 xml:id="overview-doc"> - <title>The &os; Documentation Set</title> - - <para>The <acronym>FDP</acronym> is responsible for four - categories of &os; documentation.</para> - - <itemizedlist> - <listitem> - <para><emphasis>Handbook</emphasis>: The Handbook is the - comprehensive online resource and reference for &os; - users.</para> - </listitem> - - <listitem> - <para><emphasis>FAQ</emphasis>: The <acronym>FAQ</acronym> - uses a short question and answer format to address questions - that are frequently asked on the various mailing lists and - forums devoted to &os;. This format does not permit long - and comprehensive answers.</para> - </listitem> - - <listitem> - <para><emphasis>Manual pages</emphasis>: The English language - system manual pages are usually not written by the - <acronym>FDP</acronym>, as they are part of the base system. - However, the <acronym>FDP</acronym> can reword parts of - existing manual pages to make them clearer or to correct - inaccuracies.</para> - </listitem> - - <listitem> - <para><emphasis>Web site</emphasis>: This is the main &os; - presence on the web, visible at <link xlink:href="http://www.freebsd.org/index.html">http://www.FreeBSD.org/</link>; - and many mirrors around the world. The web site is - typically a new user's first exposure to &os;.</para> - </listitem> - </itemizedlist> - - <para>Translation teams are responsible for translating the - Handbook and web site into different languages. Manual pages - are not translated at present.</para> - - <para>Documentation source for the &os; web site, Handbook, and - <acronym>FAQ</acronym> is available in the documentation - repository at - <literal>https://svn.FreeBSD.org/doc/</literal>.</para>; - - <para>Source for manual pages is available in a separate - source repository located at - <literal>https://svn.FreeBSD.org/base/</literal>.</para>; - - <para>Documentation commit messages are visible with - <command>svn log</command>. Commit messages are also - archived at <uri xlink:href="&a.svn-doc-all.url;">&a.svn-doc-all.url;</uri>.</para> - - <para>Web frontends to both of these repositories are available at <link - xlink:href="https://svnweb.FreeBSD.org/doc/"></link>; and <link - xlink:href="https://svnweb.FreeBSD.org/base/"></link>.</para>; - - <para>Many people have written tutorials or how-to articles about - &os;. Some are stored as part of the <acronym>FDP</acronym> - files. In other cases, the author has decided to keep the - documentation separate. The <acronym>FDP</acronym> endeavors to - provide links to as much of this external documentation as - possible.</para> - </sect1> - <sect1 xml:id="overview-quick-start"> <title>Quick Start</title> @@ -252,4 +185,71 @@ </step> </procedure> </sect1> + + <sect1 xml:id="overview-doc"> + <title>The &os; Documentation Set</title> + + <para>The <acronym>FDP</acronym> is responsible for four + categories of &os; documentation.</para> + + <itemizedlist> + <listitem> + <para><emphasis>Handbook</emphasis>: The Handbook is the + comprehensive online resource and reference for &os; + users.</para> + </listitem> + + <listitem> + <para><emphasis>FAQ</emphasis>: The <acronym>FAQ</acronym> + uses a short question and answer format to address questions + that are frequently asked on the various mailing lists and + forums devoted to &os;. This format does not permit long + and comprehensive answers.</para> + </listitem> + + <listitem> + <para><emphasis>Manual pages</emphasis>: The English language + system manual pages are usually not written by the + <acronym>FDP</acronym>, as they are part of the base system. + However, the <acronym>FDP</acronym> can reword parts of + existing manual pages to make them clearer or to correct + inaccuracies.</para> + </listitem> + + <listitem> + <para><emphasis>Web site</emphasis>: This is the main &os; + presence on the web, visible at <link xlink:href="http://www.freebsd.org/index.html">http://www.FreeBSD.org/</link>; + and many mirrors around the world. The web site is + typically a new user's first exposure to &os;.</para> + </listitem> + </itemizedlist> + + <para>Translation teams are responsible for translating the + Handbook and web site into different languages. Manual pages + are not translated at present.</para> + + <para>Documentation source for the &os; web site, Handbook, and + <acronym>FAQ</acronym> is available in the documentation + repository at + <literal>https://svn.FreeBSD.org/doc/</literal>.</para>; + + <para>Source for manual pages is available in a separate + source repository located at + <literal>https://svn.FreeBSD.org/base/</literal>.</para>; + + <para>Documentation commit messages are visible with + <command>svn log</command>. Commit messages are also + archived at <uri xlink:href="&a.svn-doc-all.url;">&a.svn-doc-all.url;</uri>.</para> + + <para>Web frontends to both of these repositories are available at <link + xlink:href="https://svnweb.FreeBSD.org/doc/"></link>; and <link + xlink:href="https://svnweb.FreeBSD.org/base/"></link>.</para>; + + <para>Many people have written tutorials or how-to articles about + &os;. Some are stored as part of the <acronym>FDP</acronym> + files. In other cases, the author has decided to keep the + documentation separate. The <acronym>FDP</acronym> endeavors to + provide links to as much of this external documentation as + possible.</para> + </sect1> </chapter>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201606102310.u5ANA9rG034265>