Avaya Documentation Center publishing checklist

Last Updated : Apr 10, 2024 |
Prolog information
Metadata
Keywords:
The checklist provides a high-level process of preparing the content and publishing output on Avaya Documentation Center.
Use the check list as reference. You do not have to mark each item when you complete the task.
No.
Task
Notes
1
Open the publication, and update the content for the release.
2
Ensure that DITA topic file names contain alphabets, numbers, underscores, and hyphens only.
Important:
Avoid registered marks, trademarks, and special characters, such as +-!(){}[]^"~:\&||#$@€/><,.‘;=%£&¬|`'“
DITA topic file names with special characters might not show up on Avaya Documentation Center.
3
In the Publication properties, set the correct publication type. For example, Administering and Using.
4
Ensure that the following are available on Avaya Documentation Center, and open an INFOSOLUTIONS Jira ticket to request if not already available:
  • For new program, the product name
  • The product release number for the document that you want to publish
5
In the Publication properties, ensure that you add the correct release number.
Note:
If you do not add a release number, your document might not show up when the user applies filter for this product release.
6
In the bookmap element, add the bundle name.
Note:
If you publish the output without a bundle name, the link to the document on Avaya Documentation Center contains GUID, the bookmap ID. For example, https://documentation.avaya.com/bundle/GUID-A58BC730-486D-4FEF-B67D-9F920127FBF2/page/AboutHostedServices.html
If you add the bundle name and republish the output, a second entry gets created for the same document on Avaya Documentation Center, and this time with the bundle name. https://documentation.avaya.com/bundle/UsingAvayaSubscription/page/AboutHostedServices.html
Contact IA to get the document with GUID in the URL removed from Avaya Documentation Center.
Preparing content for publishing on the Avaya Documentation Center
7
Set the homepage in the ditamap that contains the topic you want to set as home page.
Preparing content for publishing on the Avaya Documentation Center
8
(Optional) Set the scope attribute to peer in xref to link to a topic that is external to the publication.
Inserting a link to an external topic on Avaya Documentation Center
9
In the Output tab of the publication, add the Avaya Doc portal output, if not already available.
To publish the output on the development server, select the zoomindocs.avaya-staging output type.
10
Ensure that the content in the publication shows up correctly on Avaya Documentation Center.