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 missing metric documentions #23105

Open
wants to merge 19 commits into
base: 5.x-dev
Choose a base branch
from
Open

Add missing metric documentions #23105

wants to merge 19 commits into from

Conversation

sgiehl
Copy link
Member

@sgiehl sgiehl commented Mar 7, 2025

Description:

This PR significantly improves metric documentation by adding many missing entries and enhancing existing ones. Additionally, it introduces a major overhaul in how the metric glossary is generated.

Key Changes

  1. Improved Metric Documentation

    • Added missing metric descriptions.
    • Enhanced clarity and accuracy of existing documentation.
  2. Revamped Metric Glossary Generation

    • The previous approach iterated over all available reports, adding/updating metrics as they appeared. This meant the last processed report effectively determined the name and documentation of a metric, which led to inconsistencies.
    • The new approach first collects all globally defined metrics and their documentation. It then iterates over reports to capture any additional metrics while preserving report-specific documentation.
    • If a metric lacks a global default description, the system checks report-specific descriptions. If more than 50% of reports use the same definition, that becomes the default.
    • Metrics without a sufficiently consistent definition are removed from the glossary to avoid ambiguity.

Impact

These changes ensure that the glossary provides accurate and reliable metric definitions, reducing inconsistencies caused by report-specific variations.

Note

The changes are causing some test failures in submodule, which we need to resolve after review, but before merging.

fixes #17230

Review

@sgiehl sgiehl force-pushed the dev-14303 branch 4 times, most recently from 3ef3c90 to c23afee Compare March 12, 2025 10:40
@sgiehl sgiehl added this to the 5.4.0 milestone Mar 13, 2025
@sgiehl sgiehl marked this pull request as ready for review March 13, 2025 14:54
@sgiehl sgiehl added the c: Usability For issues that let users achieve a defined goal more effectively or efficiently. label Mar 13, 2025
@sgiehl sgiehl added the c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. label Mar 13, 2025
@sgiehl sgiehl requested a review from a team March 13, 2025 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: Usability For issues that let users achieve a defined goal more effectively or efficiently.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Info tooltip for every table column explaining computations behind measures
1 participant