Uploaded image for project: 'OpenShift Request For Enhancement'
  1. OpenShift Request For Enhancement
  2. RFE-8696

Improve Indexing and Cross-linking references in API documentation

XMLWordPrintable

    • Icon: Feature Request Feature Request
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • Documentation
    • None
    • Product / Portfolio Work
    • None
    • False
    • Hide

      None

      Show
      None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      1. Proposed title of this feature request
      Improve Indexing and Cross-linking references in API documentation

      2. What is the nature and description of the request?
      Customers would like to have better API documentation. Customer specifically requested better cross-linking references that allow for faster look up when it comes to sub-options connected to the API being analyzed/reviewed. Furthermore, Indexing is sometimes lacking indexing (example: logging/api-reference).

      3. Why does the customer need this? (List the business requirements here)
      It is very cumbersome to learn and work with our API documentation when every reference must be searched/found manually and sometimes it is located in another page, which complicates experimentation and learning curves unnecessarily.

      4. List any affected packages or components.
      UNK

              sstout@redhat.com Stephanie Stout
              rhn-gps-micperez Michael Perez
              None
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                None
                None