magento2 icon indicating copy to clipboard operation
magento2 copied to clipboard

Add explanatory titles to cache management buttons

Open YevhenZvieriev opened this issue 1 year ago • 13 comments

Description

This Pull Request adds explanatory titles to cache management buttons on the Cache Management page. The added titles provide users with a better understanding of the functionality of each button, making their interaction with the cache management buttons more intuitive. These changes improve the user experience and provide a better understanding of the functionality of cache management buttons on the Magento admin page because at first glance it is not clear what the difference between these two buttons is.

Changes

Added explanatory titles to the Flush Cache Storage and Flush Magento Cache buttons.

The title for the Flush Cache Storage button when you move the cursor over it now explains that it performs similar actions as the bin/magento cache:flush command: Screenshot from 2024-04-10 02-30-25

The title for the Flush Magento Cache button when you move the cursor over it now explains that it performs actions similar to the bin/magento cache:clean command:

Screenshot from 2024-04-10 02-30-34

Contribution checklist (*)

  • [x] Pull request has a meaningful description of its purpose
  • [x] All commits are accompanied by meaningful commit messages
  • [x] All new or changed code is covered with unit/integration tests (if applicable)
  • [x] README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • [x] All automated tests passed successfully (all builds are green)

Resolved issues:

  1. [x] resolves magento/magento2#38607: Add explanatory titles to cache management buttons

YevhenZvieriev avatar Apr 09 '24 15:04 YevhenZvieriev

Hi @YevhenZvieriev. Thank you for your contribution! Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:
  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

:exclamation: Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s) For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:
  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here :information_source: Run only required test builds during development. Run all test builds before sending your pull request for review.


For more details, review the Code Contributions documentation. Join Magento Community Engineering Slack and ask your questions in #github channel.

m2-assistant[bot] avatar Apr 09 '24 15:04 m2-assistant[bot]

@magento create issue

engcom-Hotel avatar Apr 10 '24 13:04 engcom-Hotel

@magento run all tests

YevhenZvieriev avatar Apr 11 '24 21:04 YevhenZvieriev

I don't think this is a good idea, the admin interface is often used by people who have no idea what bin/magento command is or how they can use it, so these extra titles might confuse them.

If you can find some well written description in English that can explain the difference between the buttons better, without using too many technical terms, then I think it would be better then mentioning developer specific jargon.

But that's just my opinion.

hostep avatar Jul 02 '24 13:07 hostep

@magento run all tests

engcom-Hotel avatar Oct 27 '25 13:10 engcom-Hotel

@engcom-Hotel, @YevhenZvieriev: doesn't my previous comment make sense to you guys? This interface is often used by non-technical users, I really wouldn't put technical jargon in this UI if I were you...

hostep avatar Oct 27 '25 22:10 hostep

Hello @YevhenZvieriev,

I agree with @hostep for this https://github.com/magento/magento2/pull/38598#issuecomment-2203104519.

Can you please update the PR for the admin panel users, which helps them in knowing the actual difference between both the buttons? Meanwhile we are moving this PR On Hold.

Thank you

engcom-Hotel avatar Oct 28 '25 09:10 engcom-Hotel

Hello @YevhenZvieriev,

Gentle reminder for this PR.

Thank you

engcom-Hotel avatar Nov 11 '25 06:11 engcom-Hotel

Hello, @engcom-Hotel,

I have updated the titles to make them clearer for admin users who might not be familiar with CLI commands. The new titles now explain the difference between the buttons in simple, user-friendly language.

Please review the changes when you have a chance. Thanks!

YevhenZvieriev avatar Nov 11 '25 10:11 YevhenZvieriev

Thank you @YevhenZvieriev for the updates.

We are picking this PR for review.

engcom-Hotel avatar Dec 12 '25 09:12 engcom-Hotel

@magento run all tests

engcom-Hotel avatar Dec 12 '25 09:12 engcom-Hotel

@magento run all tests

YevhenZvieriev avatar Dec 12 '25 13:12 YevhenZvieriev

Hi, @engcom-Hotel

The static test issues have been resolved

Please let me know if anything else is required

Thank you

YevhenZvieriev avatar Dec 12 '25 14:12 YevhenZvieriev

@magento run all tests

engcom-Hotel avatar Dec 15 '25 05:12 engcom-Hotel