Revision as of 17:38, July 21, 2020 by Mgionet (talk | contribs)
Jump to: navigation, search

RN format checking by Pubs Editors

Important
If the product/component is associated with v9.0 (formerly G-NINE):

Things to look for when checking the format of various documents.

HTML General (PA), Update, and Hot Fix RNs

BROWSER TAB

Open the RN in the browser. Hover over the browser tab – Is the correct RN name displayed?

FILE NAME

Does the file name match existing RNs?

COPYRIGHT DATE

Should start with the year of the first release and end with the year of the most current release. Example: 2013-2015

CONTENTS SECTION

  • Is the date in the release table correct? Does it match the date in the new release section?
  • Is the release type in the release table correct? Does it match the release type in the new release section header?
  • Links:
    • Check/follow the link to the Introduction section.
    • Check/follow the link in the release table to the new release section. Does it work? Does it lead to the correct release?
    • Check/follow the link to the previous RN. Does it pull up the correct file?
    • Check/follow the link to the Known Issues and Recommendations section.
    • Check/follow the link to the Discontinued Support section.
    • Check/follow the link to the Additional Information section.

INTRODUCTION SECTION

  • The Alcatel-Lucent paragraph: If the initial release of the product (listed in the release table in the Contents section) is earlier than February 1, 2012, the paragraph must remain in place. If the initial release of the product (listed in the release table) is later than February 1, 2012, the paragraph should be removed.
  • Is the introductory sentence the standard boilerplate for a General (PA) release? Occasionally, a writer will accidentally use the restricted boilerplate (“This release note applies only to the X.X releases of <Name of Component> that are specified in the Contents, above.”). Should be: “This release note applies to all X.X releases of <Name of Component>.”
  • Is the link to the SOE up-to-date? Should be: https://docs.genesys.com/Documentation/System/Current/SOE/Welcome
  • Use of Third-Party Software:
    • Does the link to the Readme pull up the correct file? Occasionally, though not very often, a writer accidentally inserts the wrong path. For example, I checked an RN recently where this link pulled up another HTML release note.
    • If the Readme for the product has transitioned to online format, the text and link should be updated appropriately. Example: "...see the <a href="http://docs.genesys.com/Documentation/GVP#More_Release_Information">Legal Notices</a> for Genesys Voice Platform."

NEW RELEASE SECTION

  • Do the date, version number, and release type in the header match the date, version number, and release type in the Contents section?
  • Do the links in the new release section header work?
  • Supported Operating Systems
    • Does the link to the Contents section work?
  • New in This Release
    • Does the boilerplate language match the release type?
      • General: “There are no restrictions for this release.”
      • Hot Fix: “This is a hot fix for this product.”
      • Update: “This is an update for this product.” or “There are no restrictions for this release.”
    • Are the new features formatted as a bulleted list? Are the bullets our standard square format?
    • If a new OS, database or browser is listed, the writer should follow the directions under SOE Information in RNs.
  • Corrections and Modifications
    • Are the item separators (gray divider lines) correctly paired? Is spacing between the item separators and the text consistent?
    • Is the JIRA number listed? Is it correctly located at the end of the closing text, or on a separate line if the item ends with a list or Workaround?
  • Does the Top of page link work?

KNOWN ISSUES AND RECOMMENDATIONS SECTION

  • Are the item separators (gray divider lines) correctly paired? Is spacing between the item separators and the text consistent?
  • If bullets are utilized, are they our standard square format?
  • Are the items listed by the version number in the Found In field (most recent version at the top)?
  • Does the Top of page link work?

DISCONTINUED SUPPORT SECTION

  • Has the opening paragraph been updated with the current SOE reference? The writer should follow the directions under SOE Information in RNs.
  • If an OS, database, browser, Java, and so on is discontinued, the writer should follow the directions under SOE Information in RNs according to the scenario that applies to her or his situation. As a cheat sheet, here's the convention based on the scenario examples here.
  • Are the item separators (gray divider lines) correctly paired? Is spacing between the item separators and the text consistent?
  • Does the Top of page link work?
Scenario 1 (Component no longer supports an SOE item but Genesys and vendor do)
  • (Online)
Discontinued as of Date: July 27, 2017 Release: 8.5.008.19
  • (HTML) July 27, 2017; 8.5.008.19
Scenario 2 (SOE item reaches Genesys EOS and the PM doesn’t extend support)
  • (Online)
Discontinued as of Date: June 30, 2018 Release: All releases
  • (HTML) June 30, 2018; All releases
Scenario 3 (SOE item reaches Genesys EOS, PM extends support, then later ends support)
  • (Online)
Discontinued as of Date: September 25, 2019 Release: All releases
  • (HTML) September 25, 2019; All releases

ADDITIONAL INFORMATION SECTION

  • If there is a link/reference to the SOE, has it been updated? The writer should follow the directions under SOE Information in RNs.
  • Does the Top of page link work?

APPROVAL/REMINDER EMAIL

After checking and approving the HTML release note, send the writer an email along these lines:

Format approved.

REMINDERS:

  • DO NOT Publish RN freeze forms for components that are part of 9.x (formerly known as G-NINE), which could include 9.1, 9.0, 8.5, and/or 8.1 components.
  • DO continue to publish RN freeze forms for components that are not part of 9.x.
  • HTML release notes: Once approved by Pubs Editors, upload the file to SharePoint and the Production repository, and place a copy of the file in \\Galaxy\tdoc_final\Current_RNs. Confirm that the file displays correctly on your document page.


ARCHIVING THE HTML FILES IN THE PRODUCTION SERVER AND SHAREPOINT

When the file has been approved and the IP test has passed, upload the file to the appropriate folder in the production server (cache2\public) and to the appropriate Genesys Public folder in SharePoint. Then refresh the map (the tool parses all of the folders to see if there is new content): https://docs.genesys.com/Special:Repository?action=refresh-map

PROBLEMS WITH THE RN FREEZE FORM

Can’t locate the release number in the drop down menu. It is possible that the IP has been frozen with a differing release type. Advise the writer to try entering another release type – does the current release number now appear in the drop down menu? If yes, there is a discrepancy between the IP and the RN. The writer should contact the Project Manager/PCT and notify them of the situation. Either the IP freeze form needs to be updated – or the RN needs to be revised to match the IP.

HTML Restricted Release Notes

Information regarding Restricted RNs can be found here: https://docs.genesys.com/Documentation/Ponydocs/1.0/Help/restrictedreleasenote

In general, restricted RNs should be standalone (just one release documented). There are exceptions to this, primarily for internal development purposes, resulting in cumulative restricted RNs. Some examples of cumulative restricted RNs:

  • Genesys Designer. Heads up! While there is one “main” cumulative RN, Designer has the occasional “branch” restricted RN for a specific customer. For these, make sure that the name of the customer is included in the file name, as well as the release number (rntitle85rn_customer_85xxxxx)
  • Workspace Web Edition & Web Services

FILE NAME

The file name uses the standard convention for HTML RNs, but incorporates the release number (preferably with no decimal points) and, if needed for clarity, the name of the customer. Examples:

  • rntitle85rn_85xxxxx.html
  • rntitle85rn_85xxxxx_customername.html

COPYRIGHT DATE

If standalone, just the current year. If cumulative, should start with the year of the first release and end with the year of the most current release. Example: 2014-2018

CONTENTS

  • Release type “Restricted” in the main release table (and in the new release section header).
  • Includes link to current General (PA) release note. (This makes it unnecessary to list Known Issues that aren’t specific to the restricted release itself.)
  • Do the links to the various sections work?

INTRODUCTION

NEW RELEASE SECTION

  • Header: Release type “Restricted”
  • New in This Release: Utilizes the “Restricted” boilerplate: “This is a restricted release for this product. For availability of this release, contact your Genesys representative. This section describes new features that were introduced in this release of <Name of Component>.”

KNOWN ISSUES AND RECOMMENDATIONS SECTION

  • Only Known Issues associated specifically with the restricted version should be listed here. If the list seems long, check with the writer.
  • Are the item separators (gray divider lines) correctly paired? Is spacing between the item separators and the text consistent?
  • If bullets are utilized, are they our standard square format?
  • Are the items listed by the version number in the Found In field (most recent version at the top)?
  • Does the Top of page link work?

DISCONTINUED SUPPORT SECTION

  • Has the opening paragraph been updated with the current SOE reference? the writer should follow the directions under SOE Information in RNs.
  • If an OS, database or browser is discontinued, the writer should follow the directions under SOE Information in RNs.
  • Are the item separators (gray divider lines) correctly paired? Is spacing between the item separators and the text consistent?
  • Does the Top of page link work?

ADDITIONAL INFORMATION SECTION

  • If there is online restricted documentation associated with the release, instructions for accessing them should be provided here including login credentials.
  • Does the Top of page link work?

DELIVERING THE RESTRICTED OR PRE-RELEASE RN

First, ask the writer to confirm with the Project Manager/PCT that the IP exists and the release type is correct (RESTRICTED or PRE-RELEASE). Doing this ahead of time will save effort later (see the NOTE at the end of this section).

  • Compose an email to the Production Builds Request email alias. Copy the writer, Pubs Editors, and the Project Manager (and any other individuals the writer deems necessary – however, the PjM should suffice). The body of the email should be something along these lines:
    • “Hello,The attached restricted RN is approved for inclusion in the IP for Genesys Designer 8.5.100.00. Let me know if you have any questions regarding this file.”
    • If there is non-online documentation (PDF, HTML, etc.) being delivered with the release: “Hello,The attached restricted RN is approved for inclusion in the IP for Genesys Designer 8.5.100.00. The attached PDF is also approved to accompany this restricted release within the Documentation folder associated with the build. Let me know if you have any questions regarding these files.”
    • Attach the approved file(s) to the email.
    • In the subject line, include the release type, the component name, and the release number. For example: Restricted RN: Genesys Designer 8.5.100.00. Note: After you receive a reply from Production Builds (usually Diana) that the RN has been included into the IP, you must remove the Production Builds alias from your thank you email as it will re-open the JIRA.
Important
If the IP is not yet in place, or the release type doesn’t match your request, Production Builds will notify you of the discrepancy. If the writer and Project Manager are not copied on this notification, you’ll need to contact them. The Project Manager/PCT is responsible for updating the release type of the IP and notifying Production Builds of the change. Suggested verbiage:

Would the appropriate member of the PCT please:

  • Republish the Component freeze form with the correct release type.
  • Send an email to ”Production Builds Request” asking that the release type of the corresponding IP be updated.

ARCHIVING THE RESTRICTED OR PRE-RELEASE RN

Restricted and Pre-release RNs are stored in SharePoint in the Restricted Docs folder in the Global IX site. NOTE: These files are not uploaded to the production server.


If this is a standalone Restricted RN or Pre-release Note, simply upload the file into the appropriate product folder. If it is a cumulative Restricted RN, locate the existing file and upload a new version.

You can upload the RN anytime after you send the email to Production Builds.

HTML Pre-release Notes

Pre-release Notes have a specific template, with specific legal boilerplate in the Introduction section.

FILE NAME

The file name uses the standard convention for HTML RNs, but substitutes “pr” for “rn”. Additionally, the release number and/or the customer name is included. Examples:

  • rntitle85pr_85xxxxx.html
  • rntitle85pr_85xxxxx_customername.html

INTRODUCTION SECTION

  • Check the second bullet item for the intended date of delivery.
  • Check the fifth bullet item for the estimated General (PA) release date.

KNOWN ISSUES SECTION

Should only list issues associated with this specific pre-release.

ADDITIONAL INFORMATION SECTION

Additional Information includes anything the Product Manager or the Project Manager feels is needed for this code drop. Generally, this should be testing information, platforms, and so on. (Not the usual list of other documents – unless the PCT insists.)

DELIVERING THE RESTRICTED OR PRE-RELEASE RN

  • First, ask the writer to confirm with the Project Manager/PCT that the IP exists and the release type is correct (RESTRICTED or PRE-RELEASE). Doing this ahead of time will save effort later (see the NOTE at the end of this section).
  • Compose an email to the Production Builds Request email alias. Copy the writer, Pubs Editors, and the Project Manager (and any other individuals the writer deems necessary – however, the PjM should suffice). The body of the email should be something along these lines: “Hello,The attached Pre-release Note is approved for inclusion in the IP for Genesys Designer 8.5.100.00. Let me know if you have any questions regarding this file.”
    • Attach the approved file to the email.
    • In the subject line, include the release type, the component name, and the release number. For example: Pre-release Note: Genesys Designer 8.5.100.00
Important
If the IP is not yet in place, or the release type doesn’t match your request, Production Builds will notify you of the discrepancy. If the writer and Project Manager are not copied on this notification, you’ll need to contact them. The Project Manager/PCT is responsible for updating the release type of the IP and notifying Production Builds of the change. Suggested verbiage:

Would the appropriate member of the PCT please:

  • Republish the Component freeze form with the correct release type.
  • Send an email to ”Production Builds Request” asking that the release type of the corresponding IP be updated.

ARCHIVING THE RESTRICTED OR PRE-RELEASE RN

Restricted and Pre-release RNs are stored in SharePoint in the Restricted Docs folder in the Global IX site. NOTE: These files are not uploaded to the production server.

If this is a standalone Restricted RN or Pre-release Note, simply upload the file into the appropriate product folder. If it is a cumulative Restricted RN, locate the existing file and upload a new version.

HTML Deployment Procedure

FILE NAME

Does the file name match the existing RP?

BROWSER TAB

Hover over the browser tab – Is the correct DP name displayed?

COPYRIGHT DATE

Should start with the year of the first release and end with the year of the most current release. Example: 2013-2015

INTRODUCTION

  • Release table: (In most cases this is the only area of the file that has been updated.) Does the new release information (Release Number; Date; Release Type) *Links: Do they lead to the anticipated location?

DEPLOYMENT PROCEDURE

In most cases, there are no changes in this section.

  • Format: Take a quick scan to see if the numbered list is in order, etc.
  • Links: Do they pull up the correct document, or lead to the anticipated location?

ARCHIVING THE HTML FILES IN THE PRODUCTION SERVER

When the file has been approved and the IP test has passed, upload the file to the appropriate folder in the production server (cache2\public) and to the appropriate Genesys Public folder in SharePoint. Then refresh the map (the tool parses all of the folders to see if there is new content): https://docs.genesys.com/Special:Repository?action=refresh-map

HTML Release Advisory

FILE NAME

Does the file name match the existing RA?

BROWSER TAB

Hover over the browser tab – Is the correct RA name displayed?

COPYRIGHT DATE

Should start with the year of the first release and end with the year of the most current release. Example: 2013-2015

ALCATEL-LUCENT PARAGRAPH

If the initial release of the product (listed in the release table in the Contents section of the associated RN) is earlier than February 1, 2012, the paragraph must remain in place. If the initial release of the product (listed in the release table) is later than February 1, 2012, the paragraph should be removed.

ITEM SEPARATORS

Are the item separators (gray divider lines) correctly paired? Is spacing between the item separators and the text consistent?

LINKS

Do they pull up the correct document, or lead to the anticipated location?

ARCHIVING THE HTML FILES IN THE PRODUCTION SERVER

When the file has been approved and the IP test has passed, upload the file to the appropriate folder in the production server (cache2\public) and to the appropriate Genesys Public folder in SharePoint. Then refresh the map (the tool parses all of the folders to see if there is new content): https://docs.genesys.com/Special:Repository?action=refresh-map

Second box title goes here

Text - under construction

ARCHIVING THE HTML FILES IN THE PRODUCTION SERVER AND SHAREPOINT

When the file has been approved and the IP test has passed, upload the file to the appropriate folder in the production server (cache2\public) and to the appropriate Genesys Public folder in SharePoint. Then refresh the map (the tool parses all of the folders to see if there is new content): https://docs.genesys.com/Special:Repository?action=refresh-map

Second box title goes here

Text - under construction Archaic retired format - check with other Pubs Editors

ONLINE Release Notes

MAIN PAGE

Look for “pink” links. Otherwise, check to see if the references/links to the SOE have been updated as noted on the SOE Information in RNs page.

  • Available Releases section:
    • Has the link/reference to the SOE been updated as noted on the SOE Information in RNs page? Should be: “The operating systems available for use with each component release are listed in the table at a high level only. For more detailed information about the supported operating environments, including requirements, supported versions, and any conditions or limitations, see the <PRODUCT NAME> (real link to the SOE page for the Product; for example, eServices) page in the Genesys Supported Operating Environment Reference Guide.”
    • Is the information in the release table correct? Release version, date, release type, restrictions, supported operating systems? Does this information match the table on the specific release page?
  • Discontinued Support section:
    • Has the link/reference to the SOE been updated as noted on the SOE Information in RNs page? Should be: "This section documents features that are no longer supported in this software. This cumulative list is in release-number order with the most recently discontinued features at the top of the list. For more information on discontinued support for operating environments and databases, see Discontinued Support in the Genesys Supported Operating Environment Reference Guide."
    • If an OS, database or browser is discontinued, follow the directions provided on the SOE Information in RNs page.
  • Related Resources section:
    • Is the section called Related Resources instead of Additional Information? Related Resources is the heading name for online RNs.
    • Has the link/reference to the SOE been updated as noted on the SOE Information in RNs page? Should be: The <PRODUCT NAME> (real link to the SOE page for the Product; for example, eServices) page in the Genesys Supported Operating Environment Reference Guide provides detailed information about the supported operating environments, including requirements, supported versions, and any conditions or limitations for <PRODUCT NAME> components.

SPECIFIC NEW RELEASE PAGE

  • Top of page:
    • Is the release version at the top of the page formatted correctly? Occasionally, writers misplace decimal points. Does it match the version number in the release table on the main page?
    • Is the information in the release table correct? Date, release type, restrictions, supported operating systems? Does this information match the table on the main page?
  • What’s New section:
    • Are new feature/enhancements formatted as a bulleted list?
    • No excess white space between items?
    • If a new OS, database or browser is listed, the writer should follow the directions provided on the SOE Information in RNs page.
  • Resolved Issues section:
    • Are the item separators (gray divider lines) correctly paired? Is spacing between the item separators and the text consistent?
    • No excess white space between items?
    • Is the JIRA number listed? Is it correctly located at the end of the closing text, or on a separate line if the item ends with a list or Workaround?

KNOWN ISSUES PAGE

  • Are the item separators (gray divider lines) correctly paired?
  • Is spacing between the item separators and the text consistent? No excess white space – either within the items or between the items? (There’s a persistent template issue that tends to insert excess white space between the text and the item separator.)

APPROVAL/REMINDER EMAIL

After checking and approving the HTML release note, send the writer an email along these lines:

Format approved.

REMINDERS:

  • DO NOT Publish RN freeze forms for components that are part of 9.x (formerly known as G-NINE, 9.0, v9.0, etc.), which could include 9.1, 9.0, 8.5, and/or 8.1 components.
  • DO continue to publish RN freeze forms for components that are not part of 9.x.
  • HTML release notes:
    • Once approved by Pubs Editors, place a copy of the file in \\Galaxy\tdoc_final\Current_RNs, and notify Pubs Editors. Pubs Editors will upload the file to the Production Server (cache2/public), and let you know when it’s done so you can confirm that the file displays correctly on your document page.


Third box title goes here

Text - under construction Part of online readme template

Third box title goes here

Text - under construction Very high level information, mostly in bulleted lists

Comments or questions about this documentation? Contact us for support!