web/html/projects/docs index.php,1.3,1.4
Karsten Wade (kwade)
fedora-extras-commits at redhat.com
Tue May 10 23:23:46 UTC 2005
Author: kwade
Update of /cvs/fedora/web/html/projects/docs
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv7592/html/projects/docs
Modified Files:
index.php
Log Message:
Changes to CVS instructions to match new module scheme, style changes -- docs -> documents.
Index: index.php
===================================================================
RCS file: /cvs/fedora/web/html/projects/docs/index.php,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.php 24 Apr 2005 11:04:20 -0000 1.3
+++ index.php 10 May 2005 23:23:44 -0000 1.4
@@ -17,7 +17,7 @@
/* Display name is the proper name of the project --
* it is displayed at the top of the page */
-$project->display_name="Docs Project";
+$project->display_name="Documentation Project";
$project->project_name="fedora-docs";
$project->cvs_module="fedora-docs";
$project->bugzilla_component="fedora-docs";
@@ -28,13 +28,13 @@
/* Project description */
$project->desc="
- <p> The goal of the Docs Project is to create easy-to-follow,
+ <p> The goal of the Documentation Project is to create easy-to-follow,
task-based documentation for $RELEASE_NAME users and
developers. Other than the Installation Guide, each document
is in article format, with one article per topic. This way,
writers can contribute documentation about a specific topic
without having to worry about how it fits into a manual or how
- it flows with other topics. Since the docs are for the
+ it flows with other topics. Since the documents are for the
$PROJECT_NAME;, they only need to describe how to perform
tasks on $RELEASE_NAME.</p>
@@ -44,14 +44,16 @@
<ul>
<li><a href=\"http://fedoraproject.org/wiki/DocsProject\">Main Wiki page</a></li>
-<li><a href=\"http://fedoraproject.org/wiki/DocsProject/MasterTasks\">List of Master Tasks</a></li>
+<li><a href=\"http://fedoraproject.org/wiki/DocsProject/NewWriters\">New Writers information page</a></li>
+<li><a href=\"http://fedoraproject.org/wiki/DocsProject/Goals\">List of Project Goals</a></li>
+<li><a href=\"http://fedoraproject.org/wiki/DocsProject/FedoraDocsSchedule\">Documentation Project Schedule</a></li>
<li><a href=\"http://fedoraproject.org/wiki/DocsProject/WhyJoin\">Why join the Docs Project?</a></li>
<li><a href=\"http://fedoraproject.org/wiki/DocsProject/SelfIntroduction\">Self Introduction Template/Instructions</a></li>
<!-- <li><a href=\"\"></a></li> -->
<!-- <li><a href=\"\"></a></li> -->
<li><a href=\"http://fedoraproject.org/wiki/DocsProject/CvsUsage\">CVS Usage Guidelines</a></li>
<li><a href=\"http://fedoraproject.org/wiki/DocsProject_2fDocumentationGuide\">Doc Guide Wiki Page</a> for tracking ideas during update cycles to the FDP Documentation Guide</li>
-<li><a href=\"http://fedoraproject.org/wiki/DocsProject/SteeringCommittee\">Fedora Docs Steering Committee</a>, FDSCo for short, aka \"Eff-Disco\"</li>
+<li><a href=\"http://fedoraproject.org/wiki/DocsProject/SteeringCommittee\">Fedora Documentation Steering Committee</a>, FDSCo for short, aka \"Eff-Disco\"</li>
</ul>
<p>
The following tools are used:
@@ -68,11 +70,11 @@
documentation in any format, as there are volunteers who will
convert into DocBook/XML. Ongoing maintenance for the new
document should happen in DocBook/XML, which will be much
- easier to learn from the converted doc.</p>
+ easier to learn from the converted document.</p>
- <p>The Docs Project is not interested in unmaintained
- documentation. If you have a doc to submit, either you or
- someone else will need to continue maintenance of the doc.
+ <p>The Documentation Project is not interested in unmaintained
+ documentation. If you have a document to submit, either you or
+ someone else will need to continue maintenance of the document.
Documentation should be focused on software found in Fedora
Core or Extras. If you have an idea outside of that scope,
please bring it to the mailing list for discussion.</p>
@@ -86,23 +88,36 @@
<li><a href=\"/participate/documentation-faq/\">Documentation Project FAQs</a></li>
</ul>
- <p> <b>NOTE:</b> The location for the Docs Project CVS has
+ <p> <b>NOTE:</b> The location for the Documentation Project CVS has
changed from what is listed below. When downloading from
anonymous CVS, use this set of commands instead: </p>
<p><code class=\"screen\">
export CVSROOT=:pserver:anonymous at cvs.fedora.redhat.com:/cvs/docs<br>
cvs -z3 login<br>
- cvs -z3 co fedora-docs</br>
+ cvs -z3 co docs-setup<br>
+ cvs -z3 co <<em>name-of-module</em>><br>
+ </code></dd>
+</p>
+<p> The first check-out command grabs the set of common files you need to build the documents, including stylesheets, common XML components, and stylesheet images. In the second check-out command, replace <<em>name-of-module</em>> with the name of the CVS module you are interested in, such as <em>documentation-guide</em>. If you do not know the name of the document module, you can see a listing of all modules in CVS with this command:</p>
+<p><code class=\"screen\">
+ export CVSROOT=:pserver:anonymous at cvs.fedora.redhat.com:/cvs/docs<br>
+ cvs -z3 login<br>
+ cvs -z3 co -c<br>
</code></dd>
</p>
";
/* tutorial topics */
$project->addMisc("Tutorial Topics","
-<p>Bug <a href=\"http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=129807\">129807</a> is being used to track tutorials in progress.</p>
-<p>Bug <a href=\"http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=129784\">129784</a> is being used to track tutorial ideas with no writer assigned to them. If you are looking for a topic, refer to this bug to see if anything sparks your interest.</p>
-<p>Documents in progress include:</p>
+<p>Bug <a
+href=\"http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=129807\">129807</a>
+is being used to track tutorials in progress.</p> <p>Bug <a
+href=\"http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=129784\">129784</a>
+is being used to track tutorial ideas with no writer assigned to
+them. If you are looking for a topic, refer to this bug to see if
+anything sparks your interest.</p> <p>Documents in progress
+include:</p>
<ul>
<li>FC3 Installation Guide</li>
@@ -112,14 +127,14 @@
");
$project->addMisc("Fedora Documentation Steering Committee (FDSCo)","
-<p> The purpose of FDSCo is to make the Docs Project a success.
-Project direction and action can be initiated by the FDSCo. Our main
-purpose is to clear the way and get stuff done. More information
-can be found at the <a
+<p> The purpose of FDSCo is to make the Documentation Project a
+success. Project direction and action can be initiated by the FDSCo.
+Our main purpose is to clear the way and get stuff done. More
+information can be found at the <a
href=\"http://www.fedoraproject.org/wiki/DocsProject/SteeringCommittee\">FDSCo
Wiki pages</a>. Our mailing list is <a
href=\"mailto:fedora-dsco-list at redhat.com\">fedora-dsco-list at redhat.com</a>.
-</p>
+</p>
<p>FDSCo Members:</p>
More information about the fedora-extras-commits
mailing list