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

Update hints and remove them where not needed #5435

Merged
merged 1 commit into from
Oct 19, 2023

Conversation

mfrecchiami
Copy link
Contributor

@mfrecchiami mfrecchiami commented Oct 13, 2023

Hints are displayed in tooltips and have to be clear and concise. Hints also have to give relevant suggestions that's why the SEO hint has been removed.

Some hints might seem obvious but these are crucial, especially when a new product is launched. We are referring to these two in particular: available_on and discontinue_on which can be confusing and could generate unwanted mistakes.
The quickest solution we want to implement in this phase is to show these hints as a visible field description (a hint in a <span> instead of a hint in a tooltip).
We've also reduced the verbosity of the two phrases, to get a message that is clear and immediate (ideally not more than two rows).

Screenshot 2023-10-16 at 15 50 10

Summary

Fixes: SOL-765

Checklist

Check out our PR guidelines for more details.

The following are mandatory for all PRs:

The following are not always needed:

  • 📖 I have updated the README to account for my changes.
  • 📑 I have documented new code with YARD.
  • 🛣️ I have opened a PR to update the guides.
  • ✅ I have added automated tests to cover my changes.
  • 📸 I have attached screenshots to demo visual changes.

promotionable_html: 'This determines whether or not promotions can apply to this product.<br>Default: Checked'
shipping_category_html: 'This determines what kind of shipping this product requires.<br> Default: Default'
tax_category_html: 'This determines what kind of taxation is applied to this product.<br> Default: %{default_tax_category}'
available_on_html: Choose a product availability date
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you explain why these texts have been updated? I think these are valuable informations for the user. Is this information displayed somewhere else now?

Hints that display in tooltip have to be clear and concise. Fields that
might have a critical effect to product creation are always visible
under the field. Hints that don't give relevant suggestions, have been
removed.
@mfrecchiami mfrecchiami force-pushed the mfrecchiami/hints-update branch from 30a0d8d to 590a7ac Compare October 16, 2023 14:33
@elia elia requested a review from tvdeyen October 16, 2023 15:10
Copy link
Member

@tvdeyen tvdeyen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. Like the distinction between tip and hint 👍🏻

Copy link
Contributor

@rainerdema rainerdema left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

@elia elia merged commit f2303d9 into solidusio:main Oct 19, 2023
2 checks passed
@elia elia deleted the mfrecchiami/hints-update branch October 19, 2023 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants