From 17da18f046bbb3a1f4b4c299f4ae61040aa4d8eb Mon Sep 17 00:00:00 2001 From: Nik Clayton Date: Wed, 14 Jul 1999 19:25:40 +0000 Subject: [PATCH] Rewritten a lot. Clearer in some places, more explicit in others (no, that does not mean "Get your XXX pics here"). Added $Id$. --- .../docproj-primer/overview/chapter.sgml | 152 ++++++++++++++---- .../books/fdp-primer/overview/chapter.sgml | 152 ++++++++++++++---- .../books/fdp-primer/overview/chapter.sgml | 152 ++++++++++++++---- 3 files changed, 363 insertions(+), 93 deletions(-) diff --git a/en/tutorials/docproj-primer/overview/chapter.sgml b/en/tutorials/docproj-primer/overview/chapter.sgml index 84fef1dc71..1322c34a6f 100644 --- a/en/tutorials/docproj-primer/overview/chapter.sgml +++ b/en/tutorials/docproj-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 $ --> Overview - 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. + 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. - After you have read this primer you should; + This document's main purpose is to clearly explain how + the FDP is organised, how to write and submit + documentation to the FDP, and how to + effectively use the tools available to you when writing + documentation. + + 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 + freebsd-doc@freebsd.org mailing list. + + After you have finished reading this document you should: - - Have an understanding of the text formats used by the - Documentation Project, and why they were chosen. + + Know which documentation is maintained by the FDP. - 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. + Be able to read and understand the SGML source code for the + documentation maintained by the FDP. + + + + Be able to make changes to the documentation. - 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. - + Be able to submit your changes back for review and eventual + inclusion in the FreeBSD documentation. + + + + The FreeBSD Documentation Set + + The FDP is responsible for four categories of FreeBSD + documentation. + + + + Manual pages + + + 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. + + The translation teams are responsible for translating the + system manual pages in to different languages. These translations + are kept within the FDP. + + + + + FAQ + + + 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. + + + + + Handbook + + + The Handbook aims to be the comprehensive on-line resource and + reference for FreeBSD users. + + + + + Web site + + + This is the main FreeBSD presence on the World Wide Web, + visible at http://www.freebsd.org/ + and many mirrors around the world. The web site is many people's + first exposure to FreeBSD. + + + + + 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 + CVSup or + CTM to keep their own local copies of + this documentation. + + 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. + - This primer assumes that you already understand; - - - - 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. - - Alternatively, how to retrieve versions of files using the - CVSWeb interface. + + Before you start + + This document assumes that you already know: + + + + 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 CVS + and either CVSup or + CTM) or by using + CVSup to download just a + checked-out copy. - - - How to use the ports system to download and install new - software. - - + + + How to download and install new software using either the + FreeBSD Ports system or &man.pkg.add.1;. + + + Overview - 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. + 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. - After you have read this primer you should; + This document's main purpose is to clearly explain how + the FDP is organised, how to write and submit + documentation to the FDP, and how to + effectively use the tools available to you when writing + documentation. + + 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 + freebsd-doc@freebsd.org mailing list. + + After you have finished reading this document you should: - - Have an understanding of the text formats used by the - Documentation Project, and why they were chosen. + + Know which documentation is maintained by the FDP. - 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. + Be able to read and understand the SGML source code for the + documentation maintained by the FDP. + + + + Be able to make changes to the documentation. - 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. - + Be able to submit your changes back for review and eventual + inclusion in the FreeBSD documentation. + + + + The FreeBSD Documentation Set + + The FDP is responsible for four categories of FreeBSD + documentation. + + + + Manual pages + + + 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. + + The translation teams are responsible for translating the + system manual pages in to different languages. These translations + are kept within the FDP. + + + + + FAQ + + + 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. + + + + + Handbook + + + The Handbook aims to be the comprehensive on-line resource and + reference for FreeBSD users. + + + + + Web site + + + This is the main FreeBSD presence on the World Wide Web, + visible at http://www.freebsd.org/ + and many mirrors around the world. The web site is many people's + first exposure to FreeBSD. + + + + + 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 + CVSup or + CTM to keep their own local copies of + this documentation. + + 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. + - This primer assumes that you already understand; - - - - 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. - - Alternatively, how to retrieve versions of files using the - CVSWeb interface. + + Before you start + + This document assumes that you already know: + + + + 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 CVS + and either CVSup or + CTM) or by using + CVSup to download just a + checked-out copy. - - - How to use the ports system to download and install new - software. - - + + + How to download and install new software using either the + FreeBSD Ports system or &man.pkg.add.1;. + + + Overview - 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. + 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. - After you have read this primer you should; + This document's main purpose is to clearly explain how + the FDP is organised, how to write and submit + documentation to the FDP, and how to + effectively use the tools available to you when writing + documentation. + + 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 + freebsd-doc@freebsd.org mailing list. + + After you have finished reading this document you should: - - Have an understanding of the text formats used by the - Documentation Project, and why they were chosen. + + Know which documentation is maintained by the FDP. - 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. + Be able to read and understand the SGML source code for the + documentation maintained by the FDP. + + + + Be able to make changes to the documentation. - 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. - + Be able to submit your changes back for review and eventual + inclusion in the FreeBSD documentation. + + + + The FreeBSD Documentation Set + + The FDP is responsible for four categories of FreeBSD + documentation. + + + + Manual pages + + + 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. + + The translation teams are responsible for translating the + system manual pages in to different languages. These translations + are kept within the FDP. + + + + + FAQ + + + 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. + + + + + Handbook + + + The Handbook aims to be the comprehensive on-line resource and + reference for FreeBSD users. + + + + + Web site + + + This is the main FreeBSD presence on the World Wide Web, + visible at http://www.freebsd.org/ + and many mirrors around the world. The web site is many people's + first exposure to FreeBSD. + + + + + 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 + CVSup or + CTM to keep their own local copies of + this documentation. + + 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. + - This primer assumes that you already understand; - - - - 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. - - Alternatively, how to retrieve versions of files using the - CVSWeb interface. + + Before you start + + This document assumes that you already know: + + + + 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 CVS + and either CVSup or + CTM) or by using + CVSup to download just a + checked-out copy. - - - How to use the ports system to download and install new - software. - - + + + How to download and install new software using either the + FreeBSD Ports system or &man.pkg.add.1;. + + +