forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ferdin...@apache.org
Subject svn commit: r407865 - in /forrest/trunk/site-author/content/xdocs: documentation_bestpractices.xml site.xml
Date Fri, 19 May 2006 17:59:27 GMT
Author: ferdinand
Date: Fri May 19 10:59:26 2006
New Revision: 407865

URL: http://svn.apache.org/viewvc?rev=407865&view=rev
Log:
Added Documentation-BP.

Added:
    forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml
Modified:
    forrest/trunk/site-author/content/xdocs/site.xml

Added: forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml?rev=407865&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml (added)
+++ forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml Fri May 19 10:59:26
2006
@@ -0,0 +1,44 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2006 The Apache Software Foundation or its licensors,
+  as applicable.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+  "http://forrest.apache.org/dtd/document-v20.dtd">
+<document>
+  <header>
+    <title>Documentation Best Practices</title>
+  </header>
+  <body>
+   
+    <section id="goldenRules">
+      <title>Golden Rules</title>
+        <p>
+            All help is welcome building and maintaining Forrest documentation. But please
take the time to read this
+            before you start.
+        </p>  
+      <ul>
+          <li><p>Never physically move an existing file in docs unless you really
have to. Consider the alternative of
+              moving the file in site. See site for examples.</p></li>
+          <li><p>If you physically move a file, make sure you add an entry in
the section '# Some moved documents' of
+              <code>site-author/content/.htaccess</code>. The entry will redirect
visitors from old (invalid) urls to
+              the new URL of a resource and should look like this:<br/>
+              <code>RedirectMatch ^/[old URL] http://[new URL]</code></p>
+          </li>
+      </ul>
+        
+    </section>
+  </body>
+</document>

Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/site.xml?rev=407865&r1=407864&r2=407865&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Fri May 19 10:59:26 2006
@@ -78,6 +78,8 @@
         <forrest-dev label="Development guidelines" href="howto-dev.html" description="Describes
tips and procedures for efficiently developing with Forrest."/>  
         <bugs label="Reporting Bugs and Issues" href="issues.html"/>
         <svnBP label="Subversion Best Practices" href="subversion_bestpractices.html"/>
+        <docsBP label="Documentation Best Practices" href="documentation_bestpractices.html"
description="What to do or
+            not to do when writing and integration documentation for Forrest."/>
         <write-howto label="Write a How-to" href="howto-howto.html"  description="Instructions
for writing
             a new howto-document"/>
         <gump-forrest label="Gump Integration" href="gump.html"/>



Mime
View raw message