From Movable Type

Contents 1 Overview 2 Creating, Editing and Compiling Release Notes in FogBugz 3 Release Notes page creation in the Documention Blog 4 Convenience Shortcut URLs

Overview

This document discusses the process of creating, publishing and accessing version-specific Movable Type release notes.

Creating, Editing and Compiling Release Notes in FogBugz

• When an engineer resolves a case (which affects an upcoming version) they click on the "release notes" link in FogBugz and write a first draft of what changed
• Prior to the release, the Product Manager (et al) edits all release notes for consumer quality and detail, culling those which are not informative or fixed intra-release issues not found in the previous publicly released versions and those which create unnecessary repetition. For the latest release, that would be done on the following pages:
  • MT Motion-public beta 2: 1/12/2009
  • MT-Motion-rc1: 1/15/2009
  • MT-Motion-rc2: 2/6/2009 (Past)
  • MT Motion/4.25-final: 3/6/2009 (Past)
• The Product Manager exports the FogBugz release notes for the new version in XML format (via the XML icon at the bottom of each page)
• The Product Manager combines and transforms the XML output into HTML markup via an XSLT stylesheet created for this purpose and kept consistent from release to release. (Note: This is an old XSLT stylesheet which needs to be updated for the new MT.org design)
• The Product Manager may elect to append a list of Known Issues to the markup if desired.

Release Notes page creation in the Documention Blog

• The final HTML markup is used as the body a new page on the Movable Type Documentation blog
  • The settings for the page are as follows:
    • Title: Movable Type N.NN Release Notes
    • Folder: Appendix: Release Notes
    • Basename: NNN (where NNN is the version number without the decimal
    • Tags: The tag @release-notes should be included in the tags list
    • Keywords: DISTRO vN.NN (where N.NN is the version number)
      • If the PRODUCT_NAME is Movable Type v5.0, the keywords field should be v5.0 (example)
      • If the PRODUCT_NAME is Movable Type DISTRO v1.0, the keywords field should be DISTRO v1.0 (example)
  • You can view all previous release notes here if you need to refer to them for clarification.

The above process creates a new version-specific release notes page at:

   http://movabletype.org/documentation/appendices/release-notes/BASENAME.html

It also includes the page body in the Movable Type Release Notes index page.

Convenience Shortcut URLs

Release notes can be also be accessed via the following shortcuts with or without a trailing slash.

• http://movabletype.org/release-notes
• http://movabletype.org/release-notes/425
• http://movabletype.org/release-notes/4.25
• http://movabletype.org/release-notes/v425
• http://movabletype.org/release-notes/v4.25
• http://movabletype.org/release-notes/mt425
• http://movabletype.org/release-notes/mt4.25

If you prefer, you can use /changelog in place of /release-notes if you prefer:

• http://movabletype.org/changelog
• http://movabletype.org/changelog/425
• http://movabletype.org/changelog/4.25
• http://movabletype.org/changelog/v425
• http://movabletype.org/changelog/v4.25
• http://movabletype.org/changelog/mt425
• http://movabletype.org/changelog/mt4.25