You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2006/05/23 02:45:27 UTC
svn commit: r408804 - in /forrest/trunk/site-author/content/xdocs:
documentation_bestpractices.xml procedures/How_to_publish_docs.xml
subversion_bestpractices.xml
Author: crossley
Date: Mon May 22 17:45:26 2006
New Revision: 408804
URL: http://svn.apache.org/viewvc?rev=408804&view=rev
Log:
Fix DOS line-endings and do 'svn propset svn:eol-style native'.
Modified:
forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml (contents, props changed)
forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml (contents, props changed)
forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml (contents, props changed)
Modified: 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=408804&r1=408803&r2=408804&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml (original)
+++ forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml Mon May 22 17:45:26 2006
@@ -1,44 +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>
+<?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>
Propchange: forrest/trunk/site-author/content/xdocs/documentation_bestpractices.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml?rev=408804&r1=408803&r2=408804&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml (original)
+++ forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml Mon May 22 17:45:26 2006
@@ -1,90 +1,90 @@
-<?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>How to Publish Forrest Documentation</title>
- <abstract>This documents the steps that the Documentation Coordinator should follow to update the Forrest
- Website.</abstract>
- </header>
- <body>
-
- <section id="About">
- <title>About this Document</title>
- <fixme author="open">This is work in progress!</fixme>
- </section>
-
- <section id="OrgDoc">
- <title>original docs</title>
-
- <source>
- <![CDATA[
- To publish from trunk/site-author/
-
- Do once:
- # Create $FORREST_HOME/deploy.svn.settings file. These credentials
- # are needed by forrestbot so that it can do your 'svn add'
- # and 'svn commit' etc. to the forrest/site/ repository.
- # The deploy.svn.settings file looks like:
- <?xml version="1.0"?>
- <project>
- <property name="deploy.svn.user" value="myApacheUsername"/>
- <property name="deploy.svn.password" value="myPassword"/>
- </project>
-
-
- # Make changes to sources, and then test, then commit.
- # Best to wait on committing the source changes until
- # you have built and reviewed the docs.
-
- # Please, please, ensure valid xml docs. Errors will be
- # reported during the 'build' phase if you don't.
- # Also it prevents other people from working with the docs,
- # which goes against the collaborative development process.
-
- # You can do 'forrest validate-xdocs" beforehand or use
- # a validating editor (link: catalog.html) or for a single doc use
- # xmllint (link: catalog.html) from the command-line, e.g.
- # xmllint --noout --valid --catalogs faq.xml
-
- # Use the forrestbot to build and then deploy to svn.apache.org ...
-
- cd site-author
- forrest -f publish.xml build
- # ... verify files in build/forrest-docs
- forrest -f publish.xml deploy -Ddeploy.svn.commit-message="my commit message"
-
- Now the files are in SVN at forrest/site
- Periodically the real website files are updated from there.
- You do not have to do anything else.
-
- ----------------------
- Note: The first time that you deploy, it will need to do
- a long svn checkout first.
-
- FIXME: That commit message technique does not work.
- The second word is treated as an ant target to be called.
- Just leave it out and forrestbot will use a default message.
- ]]>
- </source>
- </section>
-
-
- </body>
-</document>
+<?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>How to Publish Forrest Documentation</title>
+ <abstract>This documents the steps that the Documentation Coordinator should follow to update the Forrest
+ Website.</abstract>
+ </header>
+ <body>
+
+ <section id="About">
+ <title>About this Document</title>
+ <fixme author="open">This is work in progress!</fixme>
+ </section>
+
+ <section id="OrgDoc">
+ <title>original docs</title>
+
+ <source>
+ <![CDATA[
+ To publish from trunk/site-author/
+
+ Do once:
+ # Create $FORREST_HOME/deploy.svn.settings file. These credentials
+ # are needed by forrestbot so that it can do your 'svn add'
+ # and 'svn commit' etc. to the forrest/site/ repository.
+ # The deploy.svn.settings file looks like:
+ <?xml version="1.0"?>
+ <project>
+ <property name="deploy.svn.user" value="myApacheUsername"/>
+ <property name="deploy.svn.password" value="myPassword"/>
+ </project>
+
+
+ # Make changes to sources, and then test, then commit.
+ # Best to wait on committing the source changes until
+ # you have built and reviewed the docs.
+
+ # Please, please, ensure valid xml docs. Errors will be
+ # reported during the 'build' phase if you don't.
+ # Also it prevents other people from working with the docs,
+ # which goes against the collaborative development process.
+
+ # You can do 'forrest validate-xdocs" beforehand or use
+ # a validating editor (link: catalog.html) or for a single doc use
+ # xmllint (link: catalog.html) from the command-line, e.g.
+ # xmllint --noout --valid --catalogs faq.xml
+
+ # Use the forrestbot to build and then deploy to svn.apache.org ...
+
+ cd site-author
+ forrest -f publish.xml build
+ # ... verify files in build/forrest-docs
+ forrest -f publish.xml deploy -Ddeploy.svn.commit-message="my commit message"
+
+ Now the files are in SVN at forrest/site
+ Periodically the real website files are updated from there.
+ You do not have to do anything else.
+
+ ----------------------
+ Note: The first time that you deploy, it will need to do
+ a long svn checkout first.
+
+ FIXME: That commit message technique does not work.
+ The second word is treated as an ant target to be called.
+ Just leave it out and forrestbot will use a default message.
+ ]]>
+ </source>
+ </section>
+
+
+ </body>
+</document>
Propchange: forrest/trunk/site-author/content/xdocs/procedures/How_to_publish_docs.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml?rev=408804&r1=408803&r2=408804&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml (original)
+++ forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml Mon May 22 17:45:26 2006
@@ -1,39 +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>
+<?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>
Propchange: forrest/trunk/site-author/content/xdocs/subversion_bestpractices.xml
------------------------------------------------------------------------------
svn:eol-style = native