Known Issues in online RN
Starting from August 2020, the sorts algorithm for Known Issues (KI) items during the RN generation requires a particular formatting. The KI items are sorted and displayed in the following order:
- Recommendation items.
- KI items without JIRA IDs.
- Regular KI items with Found In and Fixed In values.
The KI items with release numbers are sorted on descending order starting from latest release. If two or more KI items have similar release number, then they are sorted by JIRA IDs on descending order. - KI items starting with prefix "ER" (Engineering Request).
- KI items for the documentation issues are placed at the end of the list following the software known issues.
To ensure the RN Automation tool sorts automatically, writers should adopt the following guidelines for issues such as recommendations and KI without JIRA IDs.
- Every recommendation and no JIRA ID item on the KI page should follow the following structure:
<!-- Beginning of known issues item --> <Placeholder for the KI content> <!-- {{RNKI|||}} --> <hr class="item-separator"> <!-- End of known issues item -->
- If the item is a recommendation, replace the third line with <!-- {{RNKI|RECOM-1||}} --}.
The subsequent recommendations will follow the sequence as RECOM-2, RECOM-3, etc.
Example:<!-- Beginning of known issues item --> PostgreSQL deployments require JDBC4.1 Driver Version 9.4.1211. <!-- {{RNKI|RECOM-1||}} --> <hr class="item-separator"> <!-- End of known issues item -->
- If the item is a KI without JIRA id, replace the third line with <!-- {{RNKI|NOID-1||}} --}.
The subsequent KI without JIRA IDs will follow the sequence as NOID-2, NOID-3, etc. JIRA IDs can follow after the NOID-1 string.<!-- Beginning of known issues item --> By default, user data transformation supports date and time only in ISO 8601 format: YYYY-MM-DDTHH:MI:SS. Note that the character 'T' between DD (date) and HH (hour) is required. <!-- {{RNKI|NOID-1 GIM-11256||}} --> <hr class="item-separator"> <!-- End of known issues item -->
Comments or questions about this documentation? Contact us for support!
