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

allow plugins to customize the system checks page #17394

Closed
wants to merge 1 commit into from

Conversation

Findus23
Copy link
Member

I'm not sure if this is the best solution, but at the moment it isn't possible for a plugin to change how the system checks are displayed. Ideally one could dynamically add groups like "Optional", but that sounds very complex for a minor thing.

So the easiest solution to differentiate checks from different plugins I could think of is adding icons to the label.

In addition, I added an event to the top of the page (e.g. to add a warning, notice, disclaimer, etc.). This slows things down a bit, but this is already the slowest page due to tons of I/O, so it shouldn't matter much in comparison.

If someone has a better way to do this, I'm open to suggestions.

Review

  • Functional review done
  • Potential edge cases thought about (behavior of the code with strange input, with strange internal state or possible interactions with other Matomo subsystems)
  • Usability review done (is anything maybe unclear or think about anything that would cause people to reach out to support)
  • Security review done see checklist
  • Code review done
  • Tests were added if useful/possible
  • Reviewed for breaking changes
  • Developer changelog updated if needed
  • Documentation added if needed
  • Existing documentation updated if needed

@Findus23 Findus23 added c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. RFC Indicates the issue is a request for comments where the author is looking for feedback. c: Design / UI For issues that impact Matomo's user interface or the design overall. Needs Review PRs that need a code review labels Mar 25, 2021
@diosmosis
Copy link
Member

Can't notices be done via notifications? Or is placing it at this point in the HTML better for some reason?

@Findus23
Copy link
Member Author

By notice I mean less of a one-time notification about some event, but more adding an additional explainatory paragraph on top of the page (e.g. mentioning that some of the tests are in development and failed tests doesn't have to mean something is seriously wrong, but rather to report an issue with the test)

@diosmosis
Copy link
Member

@Findus23 this could be done w/ a permanent notification (doesn't close or have a close button) that is added on every view of the page. If you're thinking about alternatives to adding an event, that could be one.

@Findus23
Copy link
Member Author

That might work (I would have to pay attention so it isn't still shown on other pages).

But I would still have the other issue of needing a way to differentiate the tests of the plugin.

@diosmosis
Copy link
Member

@Findus23 can you explain what you mean by "differentiate the tests of the plugin"? Do you mean "mark each test by which plugin it comes from"?

@Findus23
Copy link
Member Author

Do you mean "mark each test by which plugin it comes from"?

Yes. Especially make it clear to the user, which ones are core Matomo checks and which ones are checks that added by my plugin (and therefore potentionally not as stable as the core ones).

@diosmosis
Copy link
Member

And you want to do this by adding a section at the top of the page like a sort of legend? Or something else? Have you thought about adding this info next to the actual validation names or their results themselves? (Apologies if I'm misunderstanding, it's hard to visualize what's not in my head but someone else's ;) )

@flamisz flamisz mentioned this pull request Apr 7, 2021
10 tasks
@Findus23
Copy link
Member Author

Findus23 commented Apr 7, 2021

For now the workaround of using Emoji in the system check title and a permanent notification for general information on top works well enough, so I'd close this unless it is needed for something else in the future.

@Findus23 Findus23 closed this Apr 7, 2021
@sgiehl sgiehl deleted the customize-system-checks-page branch January 9, 2024 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Design / UI For issues that impact Matomo's user interface or the design overall. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. Needs Review PRs that need a code review RFC Indicates the issue is a request for comments where the author is looking for feedback.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants