Wiki RN Administration

Wiki Release Notes Administrator ("RN Admin") is responsible for the following tasks:

• Handle writers' requests for addition of Release Note Manuals for new components (or new releases of existing components).
• Coordinate with Production inclusion of RN URL into component's IP readme.
• Coordinate with Production inclusion of RN URL into Release Note definition in XING.
• Help writers with manual publication, should RN publication script fail.
• Maintain the storage (aka "Mapping Page") of Product abbreviations and Landing page links.

Use the following procedures to manage wiki Release Notes.

Naming Guidelines for RNs

Short and Display Names for Release Note Manuals

An RN short name consists of a component abbreviation (which is unique to the component), release ID (such as, 85), and suffix (such as, rn).

Important

There is a 17 character limit for RN short names.

When creating new wiki manuals for Release Notes, preserve consistency with 8.1 HTML RN names and ensure consistency across the products, whenever possible. In many cases, however, the Ponydocs limitations for URL length and allowed characters require that you modify 8.1 HTML RN names as follows:

• Eliminate or replace any of the following symbols: # < > [ ] { | }
• Replace an undescore (_)with a hyphen (-).
• Abbreviate a component name that is used in the URL so that it does not exceed 11 characters. (For components that are not localized, 13 characters is the maximum.) See the list of Commonly Used Abbreviations.

An RN display name is essentially the RN title. It consists of the full component name (which is unique to the component), release number (such as 8.5.x), and document type (such as Release Note). Consult the packaging spec and check the 8.1 HTML RN title, if available.

Forbidden Characters

The ASCII characters that are not allowed in MediaWiki page names are the three types of brackets, sharp sign, underscore and vertical bar, and all control characters (including tabs and newlines).

< > [ ] { | } # _

Note that the underscore is not really disallowed, but is treated like a space without distinction in MediaWiki page names, so "A_B" and "A B" are referencing exactly the same page name (pages will be created, searched, and displayed (with their title) using spaces, never using underscores).

Commonly Used Abbreviations

NOTE: Avoid using either "rn" or "pr" as an abbreviation. RN is already designated for Release Note, and PR is already designated as Pre-release Note.

Use the following abbreviations to shorten the component's name in the URL:

Component Identifier	Abbreviation
Adapter	adp
Agent State Connector	asc
Analytics	an
Apple Business Chat	abc
Authoring Tool	auth
Backup	bkup or b
Bot	bot
Builder	bldr
Business Process	bp
Classification	cl
Cloud	cld (including Genesys Cloud)
Cluster	c (also used for Connector)
CMS	cms
Collector	collr
Configuration	cfg
Configuration Database	cdb
Connector	c (also used for Cluster)
CX Contact	cxcontact
Dashboard	d
Data	dt
Database	db
Data Processing	dtprc
Decisions	dec
Digital	dig
Driver	drvr or dr
Endpoint	ep
Engine	eng
Framework	fr
Genesys Co-browse	gcb
Genesys Predictive Matching	gpm
History	hist
Journey Optimization Platform	jop
Knowledge	kn
Library	lib
Maintenance	mnt
Management Framework	fr (see Framework)
Manager	mgr or m
Plugin (as in GAX Plugin)	plug or pl
Policy	pol
Privacy Manager	pvm
Processing	prc
Proxy	p
Pulse	pulse
Recording	r
Recovery	rcy
Reporting	rt
Runtime	run
Sample(s)	smpl
Script(s)	sc
Server	svr
Service(s)	svc
SIP Endpoint	sep
Social	soc
Speech	sp
Subroutines	subs
Template(s)	tmpl
Text	txt
Training	tr
Utility	u
WeChat	wcht
Widget(s)	wgt

Short and Display Names for Products

References from the RN to a product landing page, such as in Helpful Links on the 7-digit release page, must use the product short and display names correctly, including the letter case. See also the Maintenance section below.

Adding a New Component

Prerequisites:

• You are logged in and are part of the RNAdmin group on docs.genesys.com.
• Component abbreviation for the Release Note is known and satisfies the requirements.

Example:

• New Component: iWD Runtime Node

  Component Abbreviation: iwd-rt-node

Note: Do not include 8.5.x Release Note in the New Component field. Do not include 85rn in the Component Abbreviation.

Instructions:

1. Point your browser to http://docs.genesys.com/Special:RNForm/Admin
2. Fill out and send the "New Component" Form.
3. Your browser will display a page with links to the DRAFT pages of the new component.
4. Check the TOC and other DRAFT pages and save them, if necessary.
5. On the "Welcome" page, add a link to the 8.1 Release Note location in Repository.
6. Send the URL of the "Welcome" page to the requesting writer.

Coordinating with Production

Changing RN Link in IP Readme

When a new RN Manual in wiki format is being created for a component, open a JIRA ticket for Production to point component's IP readme and XING RN definition to the wiki RN.

JIRA

Project: Genesys Production

Issue Type: Task

Subject: Replace link to RNs with Wiki URLs for <name_of_the_product> 8.5.0 Components

Description: In 8.5.0 IPs for the following <name_of_the_product> components, use Wiki Release Note URLs instead of links to HTML files:

<Component Abbreviation> – <New Component>

List all the components in the Description and assign the ticket to Diana Shimberg.

Example: See JIRA issues PROD-147 and PROD-148.

Including RN Link in XING Definition

In addition to the above JIRA ticket, create another JIRA task for Software Delivery(?) to create or update the Release Note definition in XING, so that it includes the URL to the wiki RN.

PENDING Need to come up with storage system (aka Mapping Page) for all RN Manuals and URLs that are being created, to which both RN Admin and Production could refer.

Maintenance of Product Abbreviations and Display Names

Current Implementation At the time of RN generation for a given component, the writer types the abbreviation and display name for the associated product in the Special RN form. These values are used to populate and activate the links in the Helpful Links section of the generated RN. In the case of typos, the links won't work and the RN Admin may need to help the writer to troubleshoot the problem.

PENDING At the time when a new RN Manual is created, RN Admin should specify the product with which a component's RN is associated. This includes information about the Ponydocs abbreviation for the product that is used in the URL of the product's landing page and the product display name that is visible on the product's landing page. These names are used as the defaults for the Helpful Links parameters, which the writer should be able to overwrite, if necessary, at the time of RN generation. These names and their relationship to a component's RN must be saved on a special mapping page, or in an alternative storage system.

Troubleshooting

Workaround for RN Publishing Failure

If the "Publish Release Note" function fails, you can manually publish the release note using the Update and Inherit Special Page from the Helpful Links sidebar.

1. Use the Update and Inherit Special Page to update the 7 digit release page, welcome page, and known issues page.
2. In the published welcome page, replace the text [[Category:RN_Draft_Welcome_Page]] with [[Category:RN_Welcome_Page]]. Also verify that the release list table is correct.
3. In the published 7-digit release page, remove text [[Category:RNDRAFT]].
4. In the published known issues page, remove text [[Category:KIDRAFT]].
5. Verify that the TOC is correct.

Updating Release Type

If you need to change the release type text for a release page, adjust the following text:

== New in This Release ==
{{:Documentation:RN:Library:RelGeneralSC:TMPLT|component=Component_Name}}

Release Type	Template
General	{{:Documentation:RN:Library:RelGeneral:TMPLT|component=Component_Name}}
General—No New	{{:Documentation:RN:Library:RelGeneralNoNew:TMPLT|component=Component_Name}}
Source Control	{{:Documentation:RN:Library:RelGeneralSC:TMPLT|component=Component_Name}}
Source Control—No New	{{:Documentation:RN:Library:RelGeneralSCNoNew:TMPLT|component=Component_Name}}
Hot Fix	{{:Documentation:RN:Library:RelHotFix:TMPLT|component=Component_Name}}
Hot Fix—No New	{{:Documentation:RN:Library:RelHotFixNoNew:TMPLT|component=Component_Name}}
Pre-release	{{:Documentation:RN:Library:RelPreRelease:TMPLT|component=Component_Name}}
Pre-release—No New	{{:Documentation:RN:Library:RelPreReleaseNoNew:TMPLT|component=Component_Name}}
Restricted	{{:Documentation:RN:Library:RelRestricted:TMPLT|component=Component_Name}}
Restricted—No New	{{:Documentation:RN:Library:RelRestrictedNoNew:TMPLT|component=Component_Name}}