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 @@ <div class="ui clearing basic segment" v-if="graphModel"> <div> <h2 class="ui left floated header"> - <a class='metric link' :href="graphModel.config.info_url" target="_blank"> + <a class='metric link' :href="graphModel.config.infoUrl" target="_blank" + title="Click through to get a more detailed definition of this metric on the Research wiki"> {{graphModel.config.fullName || 'No data yet... '}} </a> <span class="subdued granularity">{{granularity}}</span> @@ -51,7 +52,12 @@ <arrow-icon :value="changeOverRange"></arrow-icon> {{changeOverRange}}% over this time range. </h5> - <p>{{graphModel.config.description}}. <a class='metric link' :href="graphModel.config.info_url" target="_blank">More info about this metric.</a></p> + <p>{{graphModel.config.description}}. + <a class='metric link' :href="graphModel.config.infoUrl" target="_blank" + title="Click through to get a more detailed definition of this metric on the Research wiki"> + More info about this metric. + </a> + </p> </div> </div> <div v-if="!['list', 'map'].includes(graphModel.config.type)" class="ui center aligned subdued basic segment"> 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', - description: 'New pages is the page creations and page restores minus page deletions, measured monthly', + description: 'The count of new pages created, excluding pages being redirects', question: 'How many new pages each month?', + infoUrl: 'https://meta.wikimedia.org/wiki/Research:Wikistats_metrics/New_pages', defaults: { unique: { project: ['all-projects'], @@ -130,8 +133,9 @@ }, 'new-registered-users': { fullName: 'New registered users', - description: 'Newly self-created registered users counts', + description: 'The count of newly self-created registered users', question: 'How many new users are there?', + infoUrl: 'https://meta.wikimedia.org/wiki/Research:Newly_registered_user', defaults: { unique: { project: ['all-projects'] diff --git a/src/config/metrics/metricSchema.js b/src/config/metrics/metricSchema.js index a2cfa8a..d156378 100644 --- a/src/config/metrics/metricSchema.js +++ b/src/config/metrics/metricSchema.js @@ -15,7 +15,7 @@ type: 'string', required: false }, - info_url: { + infoUrl: { type: 'string', required: false }, diff --git a/src/config/metrics/reading.js b/src/config/metrics/reading.js index 030fbb9..80c0312 100644 --- a/src/config/metrics/reading.js +++ b/src/config/metrics/reading.js @@ -4,7 +4,7 @@ subtitle: 'Most viewed articles', description: 'Most viewed articles', question: 'What are the most viewed articles?', - info_url: 'https://meta.wikimedia.org/wiki/Research:Page_view', + infoUrl: 'https://meta.wikimedia.org/wiki/Research:Page_view', type: 'list', structure: 'top', defaults: { @@ -25,9 +25,9 @@ }, 'total-pageviews': { fullName: 'Total Page Views', - description: 'Page views on Wikimedia projects count the viewing of article content. In this data we try to exclude bot traffic and focus on human user page views.', + description: 'Page views on Wikimedia projects count the viewing of article content. In this data we try to exclude bot traffic and focus on human user page views', question: 'How many times are articles viewed?', - info_url: 'https://meta.wikimedia.org/wiki/Research:Page_view', + infoUrl: 'https://meta.wikimedia.org/wiki/Research:Page_view', defaults: { unique: { project: ['all-projects'], @@ -57,9 +57,9 @@ }, 'unique-devices': { fullName: 'Unique Devices', - description: 'How many distinct devices we have visiting a project in a given time period.', + description: 'How many distinct devices we have visiting a project in a given time period', question: 'How many unique devices access content?', - info_url: 'https://meta.wikimedia.org/wiki/Research:Unique_Devices', + infoUrl: 'https://meta.wikimedia.org/wiki/Research:Unique_Devices', type: 'lines', structure: 'timeseries', defaults: { -- To view, visit https://gerrit.wikimedia.org/r/402466 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ib580427b341b104b2f47289b41a19b2dd3593fa6 Gerrit-PatchSet: 2 Gerrit-Project: analytics/wikistats2 Gerrit-Branch: master Gerrit-Owner: Milimetric <dandree...@wikimedia.org> Gerrit-Reviewer: Fdans <fd...@wikimedia.org> Gerrit-Reviewer: Mforns <mfo...@wikimedia.org> Gerrit-Reviewer: Milimetric <dandree...@wikimedia.org> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
