Uploaded image for project: 'Hybrid Cloud Console'
  1. Hybrid Cloud Console
  2. RHCLOUD-22981

API.redhat.com site -- discover/refine requirements

XMLWordPrintable

    • False
    • Hide

      None

      Show
      None
    • True
    • Unset
    • CRCPLAN-156 - API.RH | M1 - Setup and Design of App on Developers.Redhat.com/api
    • No

      Design mocks for the api.redhat.com page templates.

      1. Landing page/home screen
        • Introduction
        • How to get started
        • Graphics
      2. Navigation/IA/Search 
        • Consistent hierarchy between status.redhat.com and api.redhat.com (for grouping) 
        • API indexing will be enabled, and a simple search mock works.
      3. API pages 
        • API overview page
        • Authentication page
        • Getting started page
        • Terms of Use page
        • FAQs page
        • API Spec (for each endpoint), which will come from the API spec doc
          • Endpoints
          • Parameters w/ explanations, examples, options
          • Responses
          • Errors
          • Interactive code snippet with code language toggle
          • Test API
      4. [Nice to have but not critical] Notification schema page
        • TBD - awaiting their schema layouts - imagine it will be very similar to our standard API page template.

      ENG brainstorm / exploration doc

      UX brainstorm doc

              maryshak1996 Mary Shakshober
              rhn-support-rabbott Ryan Abbott
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: