Skip to content

Spec: Introduce Community Health Score panel - #4367

Open
functionzz wants to merge 24 commits into
mozilla:mainfrom
functionzz:more_docs_changes
Open

Spec: Introduce Community Health Score panel#4367
functionzz wants to merge 24 commits into
mozilla:mainfrom
functionzz:more_docs_changes

Conversation

@functionzz

Copy link
Copy Markdown
Collaborator

This PR copies internal specs for the Insights dashboard for github access.

@functionzz
functionzz requested a review from mathjazz August 4, 2026 21:49
@mathjazz mathjazz changed the title Insights: add dashboard specification Add Insights dashboard specification Aug 5, 2026
@mathjazz mathjazz changed the title Add Insights dashboard specification Add global Insights dashboard specification Aug 5, 2026
@mathjazz mathjazz changed the title Add global Insights dashboard specification Introduce Community Health Score panel Aug 5, 2026

@mathjazz mathjazz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This sadly still needs quite a lot of work.

Lots of content is out of date and incoherent.

I would also find it much easier to read in prose, than in several nesting levels of bullet points. See other specs for reference.

Should we cover the the report system (PR #4336) here as well?

Please also add screenshots.

Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
@mathjazz mathjazz changed the title Introduce Community Health Score panel Spec: Introduce Community Health Score panel Aug 5, 2026
@functionzz

Copy link
Copy Markdown
Collaborator Author

Phew, lots of reviews :/

Should we cover the the report system (PR #4336) here as well?

Let's not do that, I was thinking of making a seperate spec for that

functionzz and others added 14 commits August 5, 2026 09:28
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
@functionzz
functionzz requested a review from mathjazz August 6, 2026 12:13

@mathjazz mathjazz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Getting there! 😅

Comment thread specs/0123-insights-dashboard.md Outdated
Comment on lines +28 to +34
- `active_managers_score`: score representation of `active_managers`
- `active_translators_score` score representation of `active_translators`
- `active_contributors_score` score representation of `active_contributors`
- `all_contributors_score` score representation of `all_contributors`
- `new_signups_score` score representation of `new_signups`
- `key_projects_enabled_score` score representation of `key_projects_enabled`
- `completion_score` score representation of `completion`

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This paragraphs doesn't add much value. Instead, we should explain the formula for calculating each of these scores.

Think of the spec as the containing sufficient information to develop the feature. It will also be helpul in the future when we'll need to understand how the score works, so we don't need to decypher the code.

Comment thread specs/0123-insights-dashboard.md Outdated
- `key_projects_enabled_score` score representation of `key_projects_enabled`
- `completion_score` score representation of `completion`

Finally the scores are combined into a **Community health score** for that locale on that month which is used for measuring locale health.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

How excatly (mathematically) are they combined?

Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
functionzz and others added 6 commits August 6, 2026 09:56
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
@functionzz
functionzz requested a review from mathjazz August 7, 2026 17:05

@mathjazz mathjazz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Left some more inline comments.

We should fix that reference to the "following scores" ans "thresholds" and we can land this.

Comment thread specs/0123-insights-dashboard.md Outdated
- `key_projects_enabled`: number of projects that are classified as key projects via the `is_chs_project` flag
- `completion`: locale completion, as a percentage of (**approved strings** + **strings with warnings**) out of **total strings**

The data used is then computed into the following scores based on predetermined thresholds. Finally the scores are summated to a **Community health score** for that locale on that month which is used for measuring locale health.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

What following scores and what thresholds?

Comment thread specs/0123-insights-dashboard.md Outdated
Comment thread specs/0123-insights-dashboard.md Outdated
functionzz and others added 3 commits August 7, 2026 14:36
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Co-authored-by: Matjaž Horvat <matjaz.horvat@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants