Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Section
Column
width60%

What's in a Release?

We expect that each Fluid release will contain a combination of framework code, reusable user interface components, and documentation. More specifically:

Technology

  • JavaScript code for the Fluid framework
  • JavaScript, HTML, and CSS for Fluid components
  • Examples and sample code
  • API documentation and tutorials

Design Handbook

  • UI Design Patterns
  • UX Walkthrough checklists and techniques
  • User testing guidelines
Column
with40%
Panel
borderColor#566b30
bgColor#fff
titleBGColor#D3E3C4
borderStylesolid
titleOn this PageborderStylesolid
Table of Contents
minLevelmaxLevel2
maxLevelminLevel2
excludeIntroduction*

Frequency of Releases

We release versions of the Fluid framework, components, and Design Handbook on a monthly basis. For more information about the contents of each monthly release, check out the Fluid Project 2007-9 Project PlanCommunity Roadmaps.

Release Version Number

Each release has a unique version number associated with it, e.g. "0.1" or "0.3beta1". This version number must be recorded consistently in a few locations:

...

  1. In Confluence, create a new wiki page as a child of the Project Coordination page called "Fluid x.y Release Status" (where x.y is the version number).
    • This can be done by copying a previous release status page, and tweaking it.
  2. Document the release goals
  3. Create a table outlining the release deliverables, including the status and coordinator for each deliverable
  4. In JIRA, create a filter showing all of the open issues corresponding to the release.
  5. Save the filter and share it publicly. This may require special access in JIRA, so ask if you need help.
  6. Grab the URL to the RSS feed of the filter.
  7. Use the jiraissues tag in Confluence to automatically pull in the contents of the RSS feed and display it in a table:

...

  1. Consider putting a disclaimer at the top of any affected pages, with the following text (or something similar):
    • "This page is currently being edited in preparation for the pending X.X release. It's contents should be considered in flux and unreliable until this warning is removed. For the latest stable release, see Fluid Infusion X.X."
  2. Duplicate the old Fluid Infusion - Current Release page into a new page called "Fluid Infusion X.X" where X.X is the old release number.
  3. Update Fluid Infusion - Current Release to the latest release.
    • Be mindful to follow the excerpt format. The links to the bundles at the top will be excerpted, and displayed on the Downloads and Demos page.
  4. Update the Downloads and Demos page to reflect any new demos that are now available.

Component pages

  1. Go to the Components page
  2. For each Component that was updated in this release, ensure that the relevant information page is updated.
  3. Update API, Integration, Demo, and Testing sections as necessary.

...

  1. House cleaning - Delete any unnecessary design information (pages, notes, etc) added to the Wiki in this past iteration.
  2. Update any Components pages to reflect the current state of the design.
    • Wireframes, Storyboards, Design pattern, Functional Req, User Testing, Story Cards, User modeling, Accessibility.
  3. Verify that any changes to the Design Handbook is reflected.

...

The following process should be carried out for two sets of technical documentation: All Components API DocumentsDocumentation and Tutorials:

  1. Start with the 'trunk' version of the first page in the set of documentation.
  2. Create a copy of the page.
    • In the left hand menu, choose "Info"
    • On the Info page, choose "Copy"
  3. Rename the copy to include the version number, using the following convention:
    • "Inline Edit API - v0.4"
  4. Adjust the parent document to be the appropriate already-versioned parent.
    • Right under the title you edited in the previous step, click the yellow-highlighted "EDIT" next to the Location
    • Type in or search for the correct new parent page
    • Click "Done"
  5. Edit the {info} block at the top of the page to declare that this page refers to the versioned doc, and they should see the other docs for trunk docs, using the following template text:
    • This documentation refers to the API documents for the v0.4 released version of the Fluid Infusion code. For documentation specific to the trunk version, please see <put a link to the trunk version of the doc here>.
  6. Check the page for any links to other version-specific pages, update the links.
  7. Preview the page to make sure it's ok.
  8. Save the page
  9. Return to the trunk version that you just created a copy of.
  10. Edit the {info} block at the top of the trunk page to refer to the new versioned page you just created (instead of the previous version that was there).

...

IMPORTANT NOTE: Once the release is complete, the Image Gallery project file, found at https://source.fluidproject.org/svn/fluid/image-gallery/trunk/web/pom.xmlImage Removed, must be updated to reflect the new SNAPSHOT version in it's Fluid dependency.

...

The distrbution file should be made available on the main project site's Downloads page (http://fluidproject.org/index.php/downloads) and on the wiki's Fluid Infusion - Current Release page.

Updating Demos on the Fluid Project website

...

If you discover a security issue, follow the Fluid Security Policy and report the issue privately to the security team.