web/html/participate/documentation-quick-start index.php, 1.1.1.1, 1.2

Thu Dec 8 11:03:48 UTC 2005

Author: kwade

Update of /cvs/fedora/web/html/participate/documentation-quick-start
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv1227/documentation-quick-start

Modified Files:
	index.php 
Log Message:
Trying to get content moved to new locations with proper redirect pages left behind.


Index: index.php
===================================================================
RCS file: /cvs/fedora/web/html/participate/documentation-quick-start/index.php,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -u -r1.1.1.1 -r1.2

--- index.php	30 Mar 2005 17:47:24 -0000	1.1.1.1
+++ index.php	8 Dec 2005 11:03:46 -0000	1.2
@@ -1,175 +1,32 @@
-<?
+<?php
+//
+// Easily-changeable template for redirection.
+//
+
+$NEWURL="http://fedora.redhat.com/docs/documentation-quick-start/";
+
 include("site.inc");
 
 $template = new Page;
 $template->initCommon();
-
 $template->displayHeader();
 
 ?>
-
-<h1>Fedora Documentation Project Quick Start Guide</h1>
-
-<p>Note: this document is still in progress. If you have any thoughts, please
-share them on the fedora-docs-list mailing list.</p>
-
-<p>
-Since reading the <a href="/participate/documentation-guide/">Documentation Guide</a> 
-can be a bit overwhelming at first, read
-this page first to understand how to start participating and the
-process used to add a tutorial to the project.
-</p>
-
-<p>
-The first step is to choose whether you want to be a writer or an editor.
-Refer to the <a href="/projects/docs/">project page</a> for each role's definition.
-Editors must first be approved by the project leader and must have experience
-with DocBook XML and the proper use of tags since all editors must follow the
-same guidelines when reviewing tutorials.
-</p>
-
-<p>
-If you are chosen as an editor, your name is added to the <a href="/projects/docs/">project page</a>,
-and your job is to wait until writers are finished writing the tutorials and
-need editing.
-</p>
+<h1>This Page Has Moved</h1>
 
 <p>
-If you choose to be a writer, the follow process must be used:
+The new location is:
 </p>
 
 <ul>
-
-<li>Refer to bug <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=fedora-docs-writing">fedora-docs-writing</a> 
-to see the list of tutorials already in progress to make sure you do not select a duplicate.</li>
-
-<li><p>If you have an idea that is not in the list of docs in progress, open a Bugzilla report
-with your idea and be sure to make bug <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=fedora-docs-writing">fedora-docs-writing</a>
-depend on it. Also, email the mailing list to let everyone know you are working on it.
-If you can't think of an idea, refer to <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=fedora-docs-ideas">fedora-docs-ideas</a>
-for a list of ideas without owners.</p>
-<p>In your Bugzilla report for the new topic, include the following information:
-<ul>
-<li>What problem it solves</li>
-<li>Summary of topic</li>
-<li>Outline for tutorial</li>
-<li>Intended target audience</li>
-<li>Whether you are the sole author or whether it is a group effort</li>
-<li>Whether it helps to create a set of documents with related themes</li>
-<li>Time estimate on when it will be finished</li>
-<li>Other resources (other than an editor) you will need to finish -- testers with similar hardware, etc.</li>
+ <li><a href="<?php echo $NEWURL; ?>"><?php echo $NEWURL; ?></a></li>
 </ul>
-</p>
-</li>
-
-<li>If you are not familiar with DocBook XML, read the <a href="/participate/documentation-guide/">Documentation Guide</a> 
-to learn how to use this format. Tutorials must be submitted in this format. Even if
-you are familiar with it, read the guide to learn how tags are used for the project
-and to learn how to setup your file to make it compatible with the CVS structure and
-the common entities file.</li>
-
-<li>Start following the conventions in the guide from the beginning such as 
-preparing your directories according to the example-tutorial.
-
-<li>Once your file is ready, attach a tarball of the files it to the bug report you 
-created so that an editor can be assigned to it. The editor should be able to untar the file
-under the fedora-docs CVS module and type make html to build it. If you need help with creating
-this structure, ask the mailing list for help or ask for an editor so he/she can help you.</li>
-
-<li>The editor will review your tutorial according to the editing guidelines (which are in progress)
-and work with you to get them corrected.</li>
-
-<li>Once the writer and editor feel it is ready to be published to the website,
-make bug <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=fedora-docs-ready">fedora-docs-ready</a> 
-depend on this bug so the project maintainer can review it and post it to the website.
-Be sure to include the CVS file versions and branch name to make sure the correction
-document is posted.</li>
-<li>Once it is posted to the website, you are still responsible for maintaining your tutorial.
-Until write access is available for CVS, submit updates to your tutorial in the form of
-patches via Bugzilla so that they can be applied.</li>
-</ul>
-
-<p>*Before* the writer hands a document over to the editor, he/she must
-verify the following:</p>
 
-<ol>
-<li>Spell check all files.</li>
-<li>Verify that all URLs are still valid.</li>
-<li>Verify that the technical content is correct -- which means follow
-your own documentation step by step to confirm.</li>
-<li>Verify that the names of the files include the language such as
-example-tutorial-en.xml.</li>
-<li>Verify that all sections have an id so all HTML files generated have
-static filenames.</li>
-<li>Verify that all ids following the naming convention in the Docs Guide</li>
-<li>Checkout the fedora-docs CVS module if you haven't already, and   
-   verify that if you drop in your directory that it builds within the 
-   CVS environment, including using a Makefile based on the existing    
-   ones.</li>
-<li>Verify the HTML Output:
-<ul>
-<li>Click all links to make sure they are valid</li>
-<li>View each page to make sure there aren't any missing images.</li>
-<li>Make sure all the images match their description in the text.</li>
-<li>Click the Legal Notice link on the title page to make sure it   
-      works and contains the FDL, that the version number has been 
-      bumped if a previous version existed, and that the last modified 
-      date has been updated.</li>
-</ul>
-</li>
-</ol>
-
-<p>Then, the editor is responsible for:</p>
-
-<ol>
-<li>Making sure the writer followed the docs conventions including using
-standard id names, verifying that the parent file follows the example
-tutorial so that it builds in CVS, and proper use of XML tags.</li>
-<li>Checking the grammar and word usage.</li>
-<li>Verifying that it is written for the intended target audience.</li>
-<li>Looking for any possible missing steps (While reading, if it feels
-like a step was omitted, ask the writer to make sure. Many times writers
-who are familiar with a procedure will leave out a step that is obvious
-to them but not to the reader.</li>
-<li>Verifying that it builds in the CVS structure</li>
-<li>Determine if the topic needs a second technical review. If it does,
-work with the writer to email the mailing lists to find someone to
-follow the document step by step to make sure it works on their system
-as well.<li>
-</ol>
-
-<h2>Summary of Tutorial Tracking</h2>
-
-<p>Bug <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=fedora-docs-ideas">fedora-docs-ideas</a>: 
-Docs ideas without owners - a general bucket for ideas for new documents or conversions that come
-*first* through the list</p>
-<p>Bug <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=fedora-docs-writing">fedora-docs-writing</a>: Docs in progress - for tracking
-documents actively being written/developed/edited</p>
-
-<p>Bug <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=fedora-docs-ready">fedora-docs-ready</a> Docs ready for going to
-fedora.redhat.com - when it is done with <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=fedora-docs-writing">fedora-docs-writing</a>, it comes here while it
-undergoes final editing to go to the website.</p>
-
-<p>This means the process of idea -> publication is: </p>
-
-<ol>
-<li>File a bug report for your document, or carry the on the one with the
-idea in it.</li>
-
-<li>Move the bug through the tracker in this order
-<pre>
-idea 	             -> 	develop 	        <-> 	publish
-fedora-docs-ideas		fedora-docs-writing		fedora-docs-ready
-</pre>
-</li>
-</ol>
-
-<p>Note: there is a double-arrow between develop <-> publish because a
-document should stay alive after it is published.  Once you have
-published a version and have moved to writing for the next version of
-Fedora Core, your document's bug moves back to <a href="http://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=fedora-docs-writing">fedora-docs-writing</a>.</p>
+<p>
+Please update your links or bookmarks accordingly.
+</p>
 
-<?
+<?php
 
 $template->displayFooter('$Date$');
 


