Avaya Documentation Center postpublishing checklist

Last Updated : Mar 15, 2024 |
Prolog information
Metadata
Keywords:
The checklist provides the high-level process to verify the content uploaded on Avaya Documentation Center.
Note:
This is a mandatory checklist, and you must mark each item when you complete the task.
No.
Task
Action
1
Ensure that the following metadata is displayed correctly:
  • Product family
  • Product name
  • Release number
  • Document type
Set the properties in:
  • Publication: Release number and Document type
  • Bookmap: Product family and product name.
2
From Library or the product landing page, open the document, and ensure that it does not display Content not found message.
Add the legal page in the bookmap of the publication if not already added.
If you still see the error message, open an INFOSOLUTIONS Jira.
3
Ensure that the bundle name defines the product name, documentation type, and release number of the document, instead of the default GUID.
Add the bundle name in the bookmap.
4
From Library or the product landing page, open the document, and ensure that the default home page is set to a meaningful topic. For example, an overview topic.
If you do not set the homepage, the page displays the legal page as homepage for the document.
Add the homepage in the topicref element in the ditamap where the preferred topic is available.
5
From Library or the product landing page, ensure that the document does not contain a duplicate entry for the same release.
The page displays the duplicate entry if you republish the same document on Avaya Documentation Center with an updated bundle name.
Identify the duplicate entry, open an INFOSOLUTIONS Jira and request to delete the duplicate entry.
6
Ensure that you fix any empty navigation links at the chapter level.
In the chapter map, add topics within the topichead instead of adding them directly.
7
Ensure that when you open the topic, the page does not display Content not found.
DITA topic file names with special characters does not show up on Avaya Documentation Center.
Ensure that the title field in DITA topic properties contains alphabets, numbers, underscores, and hyphens only.
Important:
Avoid registered marks, trademarks, and special characters, such as +!(){}[]^"~:\&||#$@€/><,.‘;=%£&¬|`'“
8
Work with Information Architect, and make the documents for the new product release available to customers and partners on the GA deadline.
Important:
If you do not perform the step, customers and partners cannot view the documents for this product release.
Related links
Preparing content for publishing on the Avaya Documentation Center