Revision as of 23:50, July 24, 2020 by Olena (talk | contribs) (Corrected with Kate's comments)
Jump to: navigation, search

Known Issues in online RN

Starting from August 2020, the sorting algorithm for Known Issues (KI) items during RN generation requires specific wiki coding. The KI items are sorted and displayed in the following order:

  1. Recommendation KI items.
  2. KI items without JIRA IDs.
  3. Regular KI items with Found In and Fixed In values.
    KI items with release numbers are sorted on descending order starting from the latest release. If two or more KI items have similar release number, they are sorted by JIRA IDs in descending order.
  4. KI items for Engineering Requests (ER prefix).
  5. Documentation KI items.

To ensure the RN Automation tool sorts KIs automatically, writers must adopt the following guidelines for issues such as recommendations and KI without JIRA IDs.

  • Every recommendation and every no JIRA ID item on the KI page must 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 a JIRA ID, replace the third line with <!-- {{RNKI|NOID-1||}} -->.
    The subsequent KI without a JIRA ID 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!