Page MenuHomePhabricator

Consolidate QuickSurveys into CentralNotice
Closed, DuplicatePublic

Description

What does QuickSurveys provide that CentralNotice should not? Why maintain two extensions instead of one? QuickSurveys may provide little value over CentralNotice, is missing some features that CentralNotice has, is rarely used, and therefore the two should be considered for convergence. This task tracks that discussion.

QuickSurveys appears to have been used about 10 times in the last 3 years.

Surveys require a developer to both build the configuration and deploy it:

QuickSurveys config
{
	"@QuickSurveysRequireHttps": "Whether to require links to external surveys to be secure",
	"QuickSurveysRequireHttps": true,
	"QuickSurveysConfig": [
		{
		"@name": "survey name",
		"name": "internal example survey",
		"@type": "internal or external link survey",
		"type": "internal",
		"@question": "survey question message key",
		"question": "ext-quicksurveys-example-internal-survey-question",
		"@description": "The message key of the description of the survey. Displayed immediately below the survey question.",
		"description": "ext-quicksurveys-example-internal-survey-description",
		"@answers": "possible answer message keys for positive, neutral, and negative",
		"answers": [
			"ext-quicksurveys-example-internal-survey-answer-positive",
			"ext-quicksurveys-example-internal-survey-answer-neutral",
			"ext-quicksurveys-example-internal-survey-answer-negative"
		],
		"@enabled": "whether the survey is enabled",
		"enabled": true,
		"@coverage": "percentage of users that will see the survey",
		"coverage": 0.5,
		"@platforms": "for each platform (desktop, mobile), which version of it is targeted (stable, beta)",
		"platforms": {
			"desktop": ["stable"],
			"mobile": ["stable", "beta"]
		}
		},
		{
		"name": "external example survey",
		"@type": "internal or external link survey",
		"type": "external",
		"@question": "survey question message key",
		"question": "ext-quicksurveys-example-external-survey-question",
		"@description": "the i18n key of the description of the survey",
		"description": "ext-quicksurveys-example-external-survey-description",
		"@link": "external link to the survey",
		"link": "ext-quicksurveys-example-external-survey-link",
		"@instanceTokenParameterName": "parameter to add to link",
		"instanceTokenParameterName": "parameterName",
		"@privacyPolicy": "The i18n key of the privacy policy text.",
		"privacyPolicy": "ext-quicksurveys-example-external-survey-privacy-policy",
		"@enabled": "whether the survey is enabled",
		"enabled": true,
		"@coverage": "percentage of users that will see the survey",
		"coverage": 0.5,
		"@platforms": "for each platform (desktop, mobile), which version of it is targeted (stable, beta)",
		"platforms": {
			"desktop": ["stable"],
			"mobile": ["stable", "beta"]
		}
		}
	]
}

Whereas CentralNotice provides a GUI:

CentralNotice_screenshot_1.jpg (922×1 px, 136 KB)

Open questions

  • Does QuickSurveys provide any value that CentralNotice should not? Does the regularity of its usage justify its maintenance cost?
  • What functionality would CentralNotice require to sunset QuickSurveys?

Previous discussions

Event Timeline

Jdlrobson added a project: Epic.
Jdlrobson subscribed.

Is this a more detailed version of T125125 ? Should we consolidate the two?

@Jdlrobson, thanks for surfacing this. I think it's generally best to use the first task for tracking if only to make it clear how old something is. Since there hasn't been much discussion on this ticket so far, I've marked this a duplicate of the task you referenced rather than the other way around. I had to repurpose the older task a little bit to make the discussion more open ended which hopefully won't bother anyone.