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

Add documentation for system checks #498

Merged
merged 6 commits into from Jul 30, 2021
Merged

Add documentation for system checks #498

merged 6 commits into from Jul 30, 2021

Conversation

tsteur
Copy link
Member

@tsteur tsteur commented Jul 29, 2021

refs matomo-org/matomo#17832

It's not perfect but at least provides a hint of how system checks can be added etc.

@tsteur tsteur marked this pull request as draft July 29, 2021 04:51
@tsteur tsteur added this to the Current sprint milestone Jul 29, 2021
@tsteur tsteur marked this pull request as ready for review July 29, 2021 04:58
docs/4.x/system-check.md Outdated Show resolved Hide resolved
docs/4.x/system-check.md Outdated Show resolved Hide resolved

Some plugins may only work when certain extra conditions are met, like having an unusual PHP extension installed or needing certain write permission on the file system. In these cases it is recommended to add new checks to the Matomo diagnostics system check which you can find by going to `Matomo Administration -> Diagnostic -> System Check`.

## Types of system checks
Copy link
Member

Choose a reason for hiding this comment

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

Given the code uses Diagnostic instead of "check", have you thought about calling them "diagnostics" here? As in Types of diagnostics

Copy link
Member

Choose a reason for hiding this comment

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

Actually if the command is named generate:system-check then it doesn't matter, ignore this

docs/4.x/system-check.md Outdated Show resolved Hide resolved
docs/4.x/system-check.md Outdated Show resolved Hide resolved
docs/4.x/system-check.md Outdated Show resolved Hide resolved
@diosmosis
Copy link
Member

left a couple small suggestions, other than @sgiehl's items, everything looks good!

tsteur and others added 5 commits July 30, 2021 10:56
Co-authored-by: dizzy <diosmosis@users.noreply.github.com>
Co-authored-by: dizzy <diosmosis@users.noreply.github.com>
Co-authored-by: Stefan Giehl <stefan@matomo.org>
Co-authored-by: dizzy <diosmosis@users.noreply.github.com>
Co-authored-by: Stefan Giehl <stefan@matomo.org>
@diosmosis diosmosis merged commit 965419b into live Jul 30, 2021
@diosmosis diosmosis deleted the systemcheck branch July 30, 2021 00:02
@innocraft-automation innocraft-automation removed this from the Current sprint milestone Jan 20, 2023
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.

None yet

4 participants