Skip to content
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

Document Help conventions #395

Open
beanh66 opened this issue Apr 27, 2020 · 8 comments
Open

Document Help conventions #395

beanh66 opened this issue Apr 27, 2020 · 8 comments
Labels
conventions lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.

Comments

@beanh66
Copy link
Contributor

beanh66 commented Apr 27, 2020

We have added a variety of help use cases to the console, but we are currently inconsistent with icon usage. We should review the help use cases and document it clearly as a convention based on PF recommendations.

Some examples today include:

  • Field level help on Environment tab (filled grey ? icon)
  • Field level help on Managed Namespace table column (filled blue ? icon)
  • Field level help for VMs (empty grey ? icon)
  • Popover help for yaml editor shortcuts
  • Inline help text
  • others?

FYI @rachael-phillips @lizsurette @matthewcarleton @beaumorley @mceledonia

@mceledonia
Copy link

Some guidelines on this as per Brian with his effort on the PatternFly Icons, I will take a look at how we can map the use cases above to these:

Info (solid) blue* - used for alert status: info (toasts, notification drawer and inline alerts)
Help (outline) gray* - used inline for tooltip help within UIs
Help (solid) light gray* - masthead to indicate a help system
We decided to just streamline which icons people should use for the inline, only have one icon style for each use case...I think it landed in a good place.

@openshift-bot
Copy link

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@openshift-ci-robot openshift-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 8, 2020
@openshift-bot
Copy link

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

@openshift-ci-robot openshift-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 8, 2020
@openshift-bot
Copy link

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

@openshift-ci-robot
Copy link

@openshift-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@itsptk
Copy link
Contributor

itsptk commented Mar 30, 2021

There is still a mix of solid help icons and outline help icons being used for inline help in the console today. @rhamilto is working on consolidating all of those to use the outline help icon via openshift/console#8471

@mceledonia One outstanding question is if link buttons (example here above the YAML editor) are affected? We weren't sure if this should also be the outline help, if the info should also change, etc?
image

@itsptk
Copy link
Contributor

itsptk commented Mar 30, 2021

/lifecycle frozen

@openshift-ci-robot openshift-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Mar 30, 2021
@itsptk
Copy link
Contributor

itsptk commented May 11, 2021

Any occurrences of the details-page-style underline help popovers that were appearing elsewhere than details pages have been converted to use the traditional field level help (?) icon, standardizing those methods. By following the PF contextual help guidelines, it seems we now mostly have a convention on when to use those types of contextual help also.

It seems the outstanding method is when to use just inline (grey) text right on that page, which probably still needs to have a convention established.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
conventions lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
None yet
Development

No branches or pull requests

5 participants