matomo-org / matomo-org/developer-documentation

Logging guide explain that WARNING and ERRORS will be displayed as a notification to the user in the UI

Open
#86 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation
Dominant language
PHP
Stars
58
Forks
88
Avg merge
6d 3h
Merged PRs (30d)
13

Description

In http://developer.piwik.org/guides/logging we could explain to plugin developers and core devs that the WARNS/ERRORS will be displayed on screen to users in the notifications.

To log messages and not have them viewed by users, other levels should be used such as notice or info etc.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the logging guide at http://developer.piwik.org/guides/logging and review its existing log-level explanations. Document that WARNING and ERROR messages appear as user notifications in the UI, and explain that notice or info should be used for messages that users should not see.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.