This project has retired. For details please refer to its Attic page.
Documentation Best Practices
Apache Software Foundation > Apache Forrest
Font size:      

Documentation Best Practices

Golden Rules

All help is welcome building and maintaining Forrest documentation. But please take the time to read this before you start.

  • 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.

  • If you physically move a file, make sure you add an entry in the section '# Some moved documents' of site-author/content/.htaccess. The entry will redirect visitors from old (invalid) urls to the new URL of a resource and should look like this:
    RedirectMatch ^/[old URL] http://[new URL]