New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Show in-context API documentation on details pages #2926
Conversation
This is quite cool. It adds a lot of info/help icons, but the discoverability/learnability improvement of something like this seems worth it, imo.
|
Yeah, I struggled with this as well. If you have ideas to reduce the clutter, I'm all ears. My other thought was to make it a click or hover on the label, but that's less discoverable.
I'm not aware of any places offhand in core console. I do feel like if the API doc is insufficient we should improve the API doc instead of swapping out the description. The API doc description is displayed in other contexts as well like
Yes! @smarterclayton had the same feedback. I was actually restructuring the code some in this PR to make that easier.
Agree. That's simple to add. |
+1 to Andy's comments above, particularly linking the breadcrumbs to the Explore page. A minor note but wondering whether the info icon would be better suited here since it's more informational rather than field level help. I think it's probably also worth thinking about how this will interact with the new edit designs where the pencil moves to the right of the description field. I think one option is to have the label, then the info, then the pencil but curious other thoughts! |
Rebased. I think this is a reasonable place for a review if we agree it's something we want. If we want to change the icon or how the popover works later, we can do that in one place since it's a shared component. The idea of having anchors on the explore page for individual properties is great, but it's a big change that we should tackle in a follow on. We can add more popovers to individual pages in follow on PRs as well. @rhamilto PTAL |
/retest |
@spadgett I chatted with @andybraren and @matthewcarleton about this a bit and came up with a possible quick solution (but I'd be happy to talk to the PF team in the future about situations like this too)
|
@spadgett here's the visual treatments that use PF4 elements, as promised earlier: |
/assign @TheRealJon |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: spadgett, TheRealJon The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/retest Please review the full test history for this PR and help us cut down flakes. |
1 similar comment
/retest Please review the full test history for this PR and help us cut down flakes. |
/retest |
1 similar comment
/retest |
For hackday, I was looking at using the OpenAPI doc to show descriptions in more places in the UI. I wanted to get input on this change. This adds a
DetailsItem
component that makes it easy to add field level help descriptions for properties on our details pages. The nice thing about this approach is it gives accurate and current descriptions for almost all fields, although sometimes they are a little technical.@openshift/team-ux-review @alimobrem @rhamilto