Versions Compared

Key

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

This document is intended to be used and kept up to date by the Fedora Release Manger.  It details the technical steps necessary to perform an official release of Fedora.

...

  1. Go to the documentation space's homepage: http://fedora-commons.org/go/fcr30
  2. Select Browse -> Advanced
  3. Select HTML Export
  4. De-select the following sections:
    1.  _inclusionsLibrary (at the top)
    2. TreeNavigation (at the bottom)
  5. Click Export and save it as fedora-3.2.1-docs.zip
  6. Upload the zip file to fedora-commons.org
    1. sftp fcrelman@fedora-commons.org
    2. cd documentation/3.2.1 (this directory should already exist)
    3. put fedora-3.2.1-docs.zip
    4. exit
  7. Unpack the zip file in the appropriate directory
    1. ssh fcrelman@fedora-commons.org
    2. cd documentation/3.2.1
    3. unzip fedora-3.2.1.zip
    4. mv FCR30/* .
    5. rmdir FCR30
    6. Make sure it's viewable at http://fedora-commons.org/documentation/3.2.1/
  8. Put the documentation in a warning frame.  This serves to remind people viewing old documentation that there is a newer version of Fedora available.
    1. See http://fedora-commons.org/documentation/3.2/ as an example of what it will look like.
    2. mv index.html to index-inside.html
    3. cp ../3.2/index.html .
  9. Edit the index-inside.html page, cleaning it up and providing a link to download the documentation for offline viewing.
    1. Open the file (e.g., in vi) and search for the text "Space Details:", replacing it with "Fedora 3.2.1 Documentation"
    2. Wiki Markup
      Insert a new line below that one, with the following HTML:
      \[ <a href="fedora-3.2.1-docs.zip">Download zip for offline viewing</a> \]
    3. A couple lines below, you will see the start of a table tag.  Remove that line, and every line below, up to and including the closing table tag.
    4. A few lines below that, change the text "Available Pages:" with "Index:"

Prepare and distribute documentation plan

...

Prepare and distribute test plan

...

  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/javadocs and http://fedora-commons.org/documentation/3.3/license/license.htmlImage Removed (these are the full URLs that should be referenced from the documentation in the wiki)
  6. Ensure the main documentation URL for this version forwards to the wiki
    1. cp ../index.html . (the parent directory already contains an index.html that forwards to the right place in the wiki)
    2. Point your browser to http://fedora-commons.org/documentation/3.3 (it should redirect to the FCR30 wiki space)

...

  • Make sure the link to the current version goes to the right place and is labeled properly.

Announce release

Send a short summary of this release, and a link to the release notes, to Let Carol Minton Morris (clt6 at cornell dot edu) and work with her to send out the release announcementknow that the release is complete and can be announced.

Depending on the significance of the release, the announcement will be disseminated in various forms to:

  • The DuraSpace blog
  • The fedora-commons.org homepage (as a news item)
  • Twitter (@FedoraRepo, others)
  • Mailing lists (fedora users, developers, possibly others)