Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For each Fedora release, there is a permanent documentation URL on the fedora-commons.org website.

For example, http://fedora-commons.org/documentation/3.2Image Removed

This URL will always resolve to the appropriate copy of the documentation for that version of Fedora.  For old releases, it will contain a browsable archive of the documentation for that release.  For the current release, it will automatically forward to the live documentation wiki: http://fedora-commons.org/go/fcr30Image Removed

In addition, this area is a convenient the place to hold serve static documentation that doesn't naturally fit in the wiki, such as generated documentation (javadocs) and third-party license information for the release.

...

  1. Build the aggregate javadocs for all of trunk
    1. mvn javadoc:javadoc (this will build them in target/site/apidocs)
    2. mv target/site/apidocs target/site/javadocs
  2. Copy the license information to target/site
    1. cp -r resources/doc/license target/site
  3. Create a jar file to upload
    1. cd target/site
    2. jar -cMf static.jar javadocs license
  4. Upload the jar to fedora-commons.org
    1. sftp fcrelman@fedora-commons.org
    2. cd documentation
    3. mkdir 3.3
    4. cd 3.3
    5. put static.jar
    6. exit
  5. Unpack the jar and ensure the static documentation is viewable on the web
    1. ssh fcrelman@fedora-commons.org
    2. cd documentation/3.3
    3. jar -xf static.jar
    4. rm static.jar
    5. Point your browser to http://fedora-commons.org/documentation/3.3/javadocsImage Removed and /license/license.html (these are the full URLs that should be referenced from the documentation in the wiki)
  6. Ensure the documentation URL forwards to the wiki
    1. cp ../index.html .
    2. Point your browser to http://fedora-commons.org/documentation/3.3Image Removed (it should redirect to the FCR30 wiki space)

...