| <?xml version="1.0" encoding="UTF-8"?> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You 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> |
