-
Story
-
Resolution: Done
-
Major
-
None
-
False
-
-
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.
- Landing page/home screen
- Introduction
- How to get started
- Graphics
- 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.
- 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
- [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.
- is cloned by
-
RHCLOUD-22981 API.redhat.com site -- discover/refine requirements
- Closed