Page MenuHomePhabricator

Create a feedback link for the IP Info infobox
Closed, ResolvedPublic5 Estimated Story Points

Description

Background

We want to have a way for users of IP Info to be able to submit feedback about the tool from the IP Info accordion on Special:Contributions. This makes it easy for the end user to provide feedback and gives us structured feedback to work with.

We want to:

  • Add a link to start editing a new section, with the feedback form in the most appropriate language preloaded in the editor
  • Do this via the WikimediaMessages extension. We may need to run a hook from IPInfo's InfoboxHandler::onSpecialContributionsBeforeMainOutput for this, or look into JavaScript hooks.

Related spike: T296272: Investigate adding a feedback link to IP Info which links to a templated input box [8H]

Acceptance criteria

  • IP Info accordion will contain a link "Submit feedback"
  • Clicking the link will take the user to this talk page on Metawiki. It automatically creates a new section for the user and pre-populates the text field with some prompts.
    • You can find an example for this here. When you enter your username in the text field and hit "New section" it takes you to a page, creates a section and populates the field with some prompts. There are more examples in the links under Notes below.
  • The prompts will be included via [TODO: link to translateable template containing prompts].
  • This should work globally. This includes:
    • The feedback links appear on every wiki where the feature is enabled.
    • The feedback links back to meta wiki with the same template. Where the translation exists, the user has the question form preloaded; where it doesn't, it goes to the fallback language (and up the fallback chain).
      • This was previously discussed in the comments on T296272.
    • The user can submit feedback in any language.
  • Once the user submits feedback, it creates a new section on the meta page.

Mock

image.png (912×2 px, 153 KB)

Figma

Notes

Before this can be done, we need:

Event Timeline

Niharika updated the task description. (Show Details)
Tchanders added a subscriber: STei-WMF.

@Niharika @STei-WMF This is blocked on creating the following template with at least one translation:

As a prerequisite for this work, we need a translateable template containing the following questions:

  • What did you find difficult to understand or do?
  • What did you find missing in this feature?
  • How else can we improve?
  • What did you like about this tool?

This should be in English and a few other languages, for testing purposes, and in as many languages as possible before deployment.

STran set the point value for this task to 5.Feb 7 2022, 5:23 PM
STran updated the task description. (Show Details)

@STei-WMF I created this template https://meta.wikimedia.org/wiki/Template:IPInfoFeedback which we can use for this task. Could you kindly provide an update here when it's translated into 2 or 3 languages please?

@STei-WMF I created this template https://meta.wikimedia.org/wiki/Template:IPInfoFeedback which we can use for this task. Could you kindly provide an update here when it's translated into 2 or 3 languages please?

This is now done.

Change 770013 had a related patch set uploaded (by Tchanders; author: Tchanders):

[mediawiki/extensions/IPInfo@master] Fire a hook from the infobox widget

https://gerrit.wikimedia.org/r/770013

Change 770015 had a related patch set uploaded (by Tchanders; author: Tchanders):

[mediawiki/extensions/WikimediaMessages@master] Add a link for feedback about the IPInfo feature

https://gerrit.wikimedia.org/r/770015

Change 770013 merged by jenkins-bot:

[mediawiki/extensions/IPInfo@master] Fire a hook from the infobox widget

https://gerrit.wikimedia.org/r/770013

Change 770015 merged by jenkins-bot:

[mediawiki/extensions/WikimediaMessages@master] Add a link for feedback about the IPInfo feature

https://gerrit.wikimedia.org/r/770015

I notice when looking at the feedback template in English, it includes the <translate> tags. Is this OK? What happens when it is saved? Will the feedback page be marked for translation? @Tchanders @Niharika

feedback_template.png (494×1 px, 46 KB)

I also wonder if it should include [[Category:Templates]]? Should it be inside a <noinclude> tag in the template?

I think @Niharika and @STei-WMF are best placed to answer this?

I think @Niharika and @STei-WMF are best placed to answer this?

I saved an example test feedback (I hope that is OK, feel free to delete at any time, or I will before we deploy to testwiki).

https://meta.wikimedia.org/wiki/IP_Editing:_Privacy_Enhancement_and_Abuse_Mitigation/IP_Info_feature/Feedback#This_is_test_feedback_for_T299936

See the page is now in the Category: Templates, and has This page contains changes which are not marked for translation at the top.

I think @Niharika and @STei-WMF are best placed to answer this?

I saved an example test feedback (I hope that is OK, feel free to delete at any time, or I will before we deploy to testwiki).

https://meta.wikimedia.org/wiki/IP_Editing:_Privacy_Enhancement_and_Abuse_Mitigation/IP_Info_feature/Feedback#This_is_test_feedback_for_T299936

See the page is now in the Category: Templates, and has This page contains changes which are not marked for translation at the top.

FYI, I have deleted the example.