Uploaded image for project: 'Red Hat Advanced Cluster Management'
  1. Red Hat Advanced Cluster Management
  2. ACM-10916

Investigate automation for generating the API documentation (Discovery)

    XMLWordPrintable

Details

    • False
    • None
    • False
    • No

    Description

      1. - [x] Mandatory Add the required version to the Fix version/s field.

      2. - [x] Mandatory Choose the type of documentation change.

      3. - [x] Mandatory for GA content:

      • [ ] Add link to dev story here: N/A
      • [ ] Add steps and/or other important conceptual information here:

      The API documentation comes directly from the APIs written by developers. With the completion of ACM-8278 to update the descriptions, an investigation into either restoring the original API documentation generation or using a similar solution would be worthwhile in order to save time and ensure consistency between the RHACM documentation and the RHACM code. Some options are:

      Attachments

        Activity

          People

            bswope@redhat.com Brandi Swope
            dhaiduce Dale Haiducek
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated: