[MediaWiki-commits] [Gerrit] analytics/wikistats2[master]: Add documentation links to each metric
Fdans has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/402466 ) Change subject: Add documentation links to each metric .. Add documentation links to each metric As part of this, a new landing page has been created at https://meta.wikimedia.org/wiki/Research:Wikistats_metrics and sub-pages that define each metric were linked from each metric configuration. These pages should be improved going forward, but this change fixes the more immediate problem that right now metrics don't link anywhere. Bug: T183188 Change-Id: Ib580427b341b104b2f47289b41a19b2dd3593fa6 --- M src/components/detail/GraphPanel.vue M src/config/metrics/content.js M src/config/metrics/contributing.js M src/config/metrics/metricSchema.js M src/config/metrics/reading.js 5 files changed, 30 insertions(+), 17 deletions(-) Approvals: jenkins-bot: Verified Fdans: Looks good to me, approved diff --git a/src/components/detail/GraphPanel.vue b/src/components/detail/GraphPanel.vue index 520077e..375276b 100644 --- a/src/components/detail/GraphPanel.vue +++ b/src/components/detail/GraphPanel.vue @@ -3,7 +3,8 @@ - + {{graphModel.config.fullName || 'No data yet... '}} {{granularity}} @@ -51,7 +52,12 @@ {{changeOverRange}}% over this time range. -{{graphModel.config.description}}. More info about this metric. +{{graphModel.config.description}}. + +More info about this metric. + + diff --git a/src/config/metrics/content.js b/src/config/metrics/content.js index b4ec096..1631cef 100644 --- a/src/config/metrics/content.js +++ b/src/config/metrics/content.js @@ -1,8 +1,9 @@ module.exports = { 'absolute-bytes': { fullName: 'Absolute bytes diff', -description: 'Absolute sum of all diff bytes in a project', -question: 'How many bytes have been changed?', +description: 'The sum of the absolute differences in bytes made by each edit (or revision), including edits on redirects. In other words, counting negative differences as positive', +question: 'What are the total number of bytes added and removed?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Bytes#Absolute_Bytes_Difference', defaults: { unique: { project: ['all-projects'], @@ -41,8 +42,9 @@ }, 'edited-pages': { fullName: 'Edited pages', -description: 'Number of pages edited', +description: 'The number of pages edited, excluding redirect pages', question: 'How many pages are edited?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Edited_pages', defaults: { unique: { project: ['all-projects'], @@ -90,8 +92,9 @@ }, 'net-bytes': { fullName: 'Net bytes difference', -description: 'Net difference between current byte size of a project and last period\'s', -question: 'How did the size in bytes change since last period?', +description: 'The sum of the differences in bytes made by each edit (or revision), including edits on redirects', +question: 'How did the overall size in bytes change since last period?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Bytes#Net_Bytes_Difference', defaults: { unique: { project: ['all-projects'], diff --git a/src/config/metrics/contributing.js b/src/config/metrics/contributing.js index 7308dea..290d339 100644 --- a/src/config/metrics/contributing.js +++ b/src/config/metrics/contributing.js @@ -2,8 +2,9 @@ 'editors': { disabled: true, fullName: 'Editors', -description: 'Number of editors at a time period.', +description: 'The count of editors with one or more edits, including on redirect pages', question: 'How many editors are there?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Editors', defaults: { unique: { project: ['all-projects'], @@ -51,8 +52,9 @@ }, 'edits': { fullName: 'Edits', -description: 'Number of wiki edits in a time period', +description: 'The count of edits (or revisions), including edits on redirects', question: 'How many edits have been made?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Edits', defaults: { unique: { project: ['all-projects'], @@ -91,8 +93,9 @@ 'new-pages': { disabled: true, fullName: 'New pages', -
[MediaWiki-commits] [Gerrit] analytics/wikistats2[master]: Add documentation links to each metric
Milimetric has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/402466 ) Change subject: Add documentation links to each metric .. Add documentation links to each metric As part of this, a new landing page has been created at https://meta.wikimedia.org/wiki/Research:Wikistats_metrics and sub-pages that define each metric were linked from each metric configuration. These pages should be improved going forward, but this change fixes the more immediate problem that right now metrics don't link anywhere. Bug: T183188 Change-Id: Ib580427b341b104b2f47289b41a19b2dd3593fa6 --- M src/components/detail/GraphPanel.vue M src/config/metrics/content.js M src/config/metrics/contributing.js M src/config/metrics/metricSchema.js M src/config/metrics/reading.js 5 files changed, 30 insertions(+), 17 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/analytics/wikistats2 refs/changes/66/402466/1 diff --git a/src/components/detail/GraphPanel.vue b/src/components/detail/GraphPanel.vue index 520077e..375276b 100644 --- a/src/components/detail/GraphPanel.vue +++ b/src/components/detail/GraphPanel.vue @@ -3,7 +3,8 @@ - + {{graphModel.config.fullName || 'No data yet... '}} {{granularity}} @@ -51,7 +52,12 @@ {{changeOverRange}}% over this time range. -{{graphModel.config.description}}. More info about this metric. +{{graphModel.config.description}}. + +More info about this metric. + + diff --git a/src/config/metrics/content.js b/src/config/metrics/content.js index b4ec096..1631cef 100644 --- a/src/config/metrics/content.js +++ b/src/config/metrics/content.js @@ -1,8 +1,9 @@ module.exports = { 'absolute-bytes': { fullName: 'Absolute bytes diff', -description: 'Absolute sum of all diff bytes in a project', -question: 'How many bytes have been changed?', +description: 'The sum of the absolute differences in bytes made by each edit (or revision), including edits on redirects. In other words, counting negative differences as positive', +question: 'What are the total number of bytes added and removed?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Bytes#Absolute_Bytes_Difference', defaults: { unique: { project: ['all-projects'], @@ -41,8 +42,9 @@ }, 'edited-pages': { fullName: 'Edited pages', -description: 'Number of pages edited', +description: 'The number of pages edited, excluding redirect pages', question: 'How many pages are edited?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Edited_pages', defaults: { unique: { project: ['all-projects'], @@ -90,8 +92,9 @@ }, 'net-bytes': { fullName: 'Net bytes difference', -description: 'Net difference between current byte size of a project and last period\'s', -question: 'How did the size in bytes change since last period?', +description: 'The sum of the differences in bytes made by each edit (or revision), including edits on redirects', +question: 'How did the overall size in bytes change since last period?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Bytes#Net_Bytes_Difference', defaults: { unique: { project: ['all-projects'], diff --git a/src/config/metrics/contributing.js b/src/config/metrics/contributing.js index 7308dea..0335596 100644 --- a/src/config/metrics/contributing.js +++ b/src/config/metrics/contributing.js @@ -2,8 +2,9 @@ 'editors': { disabled: true, fullName: 'Editors', -description: 'Number of editors at a time period.', +description: 'The count of editors performing edits, including on redirect pages', question: 'How many editors are there?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Editors', defaults: { unique: { project: ['all-projects'], @@ -51,8 +52,9 @@ }, 'edits': { fullName: 'Edits', -description: 'Number of wiki edits in a time period', +description: 'The count of edits (or revisions), including edits on redirects', question: 'How many edits have been made?', +infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/Edits', defaults: { unique: { project: ['all-projects'], @@ -91,8 +93,9 @@ 'new-pages': { disabled: true, fullName: 'New page