You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by fe...@apache.org on 2006/05/17 14:39:59 UTC
svn commit: r407237 - in /forrest/trunk/site-author/content/xdocs: site.xml
subversion_bestpractices.xml
Author: ferdinand
Date: Wed May 17 05:39:59 2006
New Revision: 407237
URL: http://svn.apache.org/viewcvs?rev=407237&view=rev
Log:
Addes Subversion best Practice Collection, Started restructuring 0.8 version specific stuff
Added:
forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml
Modified:
forrest/trunk/site-author/content/xdocs/site.xml
Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/site.xml?rev=407237&r1=407236&r2=407237&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Wed May 17 05:39:59 2006
@@ -73,11 +73,13 @@
<internal-xhtml label="Internal XHTML" href="internal-xhtml.html"/>
</plan>
<zone label="Zone notes Testbed" href="http://forrest.zones.apache.org" description="Access to forrest.zones.apache.org" />
+
</infrastructure>
<procedures label="Procedures & Best Practice" tab="project" description="Procedures and best practices for common tasks">
<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"/>
<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"/>
@@ -229,30 +231,62 @@
<!-- Insert all instructional documentation here -->
<howto label="How-To" href="howto/">
<overview label="Overview" href="index.html"/>
+ <ForrestInstall label="Install Forrest">
+
+ <your-project label="Using Forrest" href="your-project.html">
+ <new_content_type href="#adding_new_content_type"/>
+ <new_dtd href="#new_dtd"/>
+ <webapp href="#webapp"/>
+ <skins href="#skins"/>
+ <new-skin href="#new_skin"/>
+ <invoking_from_ant href="#invoking_from_ant"/>
+ </your-project>
+ </ForrestInstall>
+ <ForrestUse label="Use Forrest">
+
+ </ForrestUse>
- <write-howto label="Write a How-to" href="site:procedures/write-howto" description="Instructions for writing
- a new howto-document"/>
+ <ForrestAdapt label="Adapt Forrest" description="Adapt and tune Forrest for your needs">
+ <editcss label="Edit CSS (WYSIWYG)" href="howto-editcss.html"/>
+
+ <pdf-tab label="Create tab PDF" href="howto-pdf-tab.html" description="Generate one pdf-document for all
+ pages of a tab"/>
+ <custom-html-source label="Custom html source" href="howto-custom-html-source.html"/>
+ </ForrestAdapt>
+
+ <ForrestExtend label="Extend Forrest" description="Extend Forrest with new functionalities">
+ <buildPlugin label="Build a Plugin" href="howto-buildPlugin.html"/>
+ </ForrestExtend>
<asf-mirror label="Download mirror" href="howto-asf-mirror.html"/>
- <pdf-tab label="Create tab PDF" href="howto-pdf-tab.html"/>
- <editcss label="Edit CSS (WYSIWYG)" href="howto-editcss.html"/>
- <corner-css label="CSS corner SVG" href="howto-corner-images.html"/>
+
+
+
<maven label="Maven Integration" href="howto-forrest-from-maven.html"/>
- <buildPlugin label="Build a Plugin" href="howto-buildPlugin.html"/>
- <custom-html-source label="Custom html source" href="howto-custom-html-source.html"/>
- <multi label="Multipage HowTo" href="multi/">
- <intro label="Introduction" href="howto-multi.html"/>
- <step1 label="Step 1" href="step1.html"/>
- <step2 label="Step 2" href="step2.html"/>
- <step3 label="Step 3" href="step3.html"/>
- </multi>
+
+
+
<dispatcher label="Dispatcher">
<install label="Install" href="howto-dispatcher-install.html"/>
<structurer label="Structurer" href="howto-structurer-dsl.html"/>
<quickstart label="Quickstart" href="howto-dispatcher-quickstart.html"/>
<contracts label="Contracts" href="howto-structurer-contracts.html"/>
</dispatcher>
+
+
+ <documentationCreate label="Adding Documentation" description="Instructions to enhance Forrest by writing
+ new pieces of documentation.">
+ <write-howto label="Write a How-to" href="site:procedures/write-howto" description="Instructions for writing
+ a new howto-document"/>
+ <multi label="Multipage HowTo" href="multi/">
+ <intro label="Introduction" href="howto-multi.html"/>
+ <step1 label="Step 1" href="step1.html"/>
+ <step2 label="Step 2" href="step2.html"/>
+ <step3 label="Step 3" href="step3.html"/>
+ </multi>
+ </documentationCreate>
+
</howto>
<faq label="FAQs" href="faq.html">
@@ -271,17 +305,11 @@
<requirements href="#requirements"/>
<xml-entities href="#xml-entities"/>
</faq>
+
<changes label="Changes" href="changes.html"/>
<changes-rss href="changes.rss"/>
<todo label="Todo" href="todo.html"/>
- <your-project label="Using Forrest" href="your-project.html">
- <new_content_type href="#adding_new_content_type"/>
- <new_dtd href="#new_dtd"/>
- <webapp href="#webapp"/>
- <skins href="#skins"/>
- <new-skin href="#new_skin"/>
- <invoking_from_ant href="#invoking_from_ant"/>
- </your-project>
+
<locationmap label="Locationmap" href="locationmap.html"/>
<validation label="XML Validation" href="validation.html"/>
<linking label="Menus and Linking" href="linking.html">
Added: forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml?rev=407237&view=auto
==============================================================================
--- forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml (added)
+++ forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml Wed May 17 05:39:59 2006
@@ -0,0 +1,39 @@
+<?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>Subversion Best Practices</title>
+ </header>
+ <body>
+
+ <section id="goldenRules">
+ <title>Golden Rules</title>
+ <p>
+ Using subversion seems so easy. But there are so many things you can do to mess up other peoples work. This
+ document tries to name just a few:
+ </p>
+ <ul>
+ <li>When moving an existing file please use "svn move fromFile toFile". This ensures
+ that the history of the item is not lost.</li>
+ </ul>
+
+ </section>
+ </body>
+</document>
Re: svn commit: r407237 - in /forrest/trunk/site-author/content/xdocs:
site.xml subversion_bestpractices.xml
Posted by Ross Gardler <rg...@apache.org>.
ferdinand@apache.org wrote:
> Author: ferdinand
> Date: Wed May 17 05:39:59 2006
> New Revision: 407237
>
> URL: http://svn.apache.org/viewcvs?rev=407237&view=rev
> Log:
> Addes Subversion best Practice Collection, Started restructuring 0.8 version specific stuff
>
> Added:
> forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml
Brilliant, I've been thinking we need something like that for a long time.
I wonder if there is already such a document that we can utilise. We
are, afterall, about incorporating content for multiple locations.
If we can't find such a document we should try and move this up to a
higher level ASF location where it can be managed by all projects.
Ross