Preparing the Formaggio Release Notes for Publishing

Note: The content on this page has been heavily altered to redact confidential work information. 🧀

—

This page describes the process of preparing the Formaggio release notes for publishing.

Setting Up a Mozzarella Draft Page

To set up a Mozzarella draft page:

  1. Copy the most recent Mozzarella release notes draft page. For example, for the 1.6 release copy the 1.5 page.

  2. Rename the page for the current release. For example, rename "Copy of Mozzarella Release Notes - v1.5" to "Mozzarella Release Notes - v1.6".

  3. Update the content as follows:

    1. Replace the bullet points in each section with one bullet that says TBD. Keep any issues from the last release that were pushed to this release.

    2. Change all SME signoffs from a check mark to an X.

Updating the Asiago Content

To update the Asiago content:

  1. Gather information on what to include from the following sources:

    1. The Pecorino Board:

      • The cheesemaker SME team maintains this board. Copy all of the information provided and paste it in the Mozzarella draft page.

    2. The Ricotta Board:

      • To view all issues associated with a specific Formaggio release version, select the correct version and then select Issues in Cheesy Version. A list of the issues in that version appears.

      • Check for a Ricotta Release Comment.

        1. Select a Ricotta issue from the Issues in Cheesy Version list. A detailed page for that issue appears.

        2. Select the Commentary tab and copy the Ricotta release comment. If there is no Commentary tab, the Ricotta release comment is not available. In that case, confirm with an SME that the issue does not need to be part of the Formaggio release notes.

        3. Paste the copied Ricotta release comment onto the Mozzarella draft page.

  2. Update New Gooey Features with a high-level summary of the major new features included in the release.

  3. Update Stretchy Highlights with a high-level summary of the major new changes included in the release. This includes bug fixes, improvements, and changes requested by the client.

  4. Update Salty Deployment with a summary of all changes to deployment that require a customer to redeploy the product.

  5. Update Known Cheesy Issues.

    1. Maintain the list from release to release unless an item has been specifically resolved.

    2. To add a new item, create a unique identifier with the type of cheese and the current version number. For example, “FONTINA-1.6”.

    3. To resolve an item, strike it from this section.

Reviewing the Content with Cheesemakers

To review the content with cheesemaker SMEs, schedule a meeting for the day of the release for a final review and signoff on the content. Make sure to serve a wide selection of cheeses for them to nibble on.

Publishing the Formaggio Release Notes

To publish the Formaggio release notes:

  1. Remove all internal notes from the page.

  2. Confirm that the formatting of the page is correct.

  3. Confirm that all links point to the correct pages.

    1. All Cheese Wheel anchor links must point to #CheeseWheel.

    2. Other links must be "relative links" to other Formaggio Library pages and not absolute web links.

  4. Save the page with the save comment "Published for version 1.X".