From 9971c4fb180b8c5a744b48ebef5642989a62c589 Mon Sep 17 00:00:00 2001 From: "Paul W. Frields" Date: Sat, 3 Mar 2007 00:03:49 +0000 Subject: Better hinting for choosing module names; caution about using distro name redundantly --- en_US/getting-files.xml | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) (limited to 'en_US/getting-files.xml') diff --git a/en_US/getting-files.xml b/en_US/getting-files.xml index c86a6d4..6104eb4 100644 --- a/en_US/getting-files.xml +++ b/en_US/getting-files.xml @@ -79,7 +79,7 @@ cvs co docs-common
Filename Conventions - &FDP; provides the tools, scripts, and stylesheets to transform your + The &FDP; provides the tools, scripts, and stylesheets to transform your XML documents into other output formats such as HTML. In addition, these tools can build your document into a RPM package. To take advantage of these @@ -91,16 +91,28 @@ cvs co docs-common Each document lives in a peer directory to the docs-common directory you extracted from the &FED; archive earlier. On the CVS server, these directories are called - modules. Choose a module name that accurately - reflects your document's subject, but avoid any name already taken. Use + modules. Use the cvs co -c command to view existing module names. + + Partial List of CVS Modules + cd ~/localrepo/fedora-docs/ +build-docs infrastructure/build-docs +cvsroot CVSROOT +desktop-up2date desktop-up2date +developer-guide developer-guide +docs . +docs-common docs-common +documentation-guide documentation-guide +example-tutorial example-tutorial + + Choose a module name that accurately reflects your + document's subject, but avoid any name already taken. Avoid Redundancy - Do not use the word &FED; in your module - name. Since all documents in the repository are &FED; documentation, - using this term creates unnecessary confusion. + Do not use the word &FED; to name + modules in the &FDP; CVS repository.
-- cgit