Document Help conventions

[beanh66]

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]

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]

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-bot]

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-bot]

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]

@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]

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?

[itsptk]

/lifecycle frozen

[itsptk]

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.