jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/349258 )
Change subject: Add link to documentation ...................................................................... Add link to documentation Removing documentation from README.md and poiting to mediawiki.org helps us to keep documentation up-to-date and in one place. Bug: T153913 Change-Id: I21eceb7f967e3e641c8b55513bbfe6dafdc118e0 --- M README.md 1 file changed, 2 insertions(+), 39 deletions(-) Approvals: jenkins-bot: Verified Jdlrobson: Looks good to me, approved diff --git a/README.md b/README.md index 5c228f3..bb90cff 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,6 @@ QuickSurveys Extension ======================== -The QuickSurveys extension displays and gathers data via EventLogging for configured surveys in both desktop and mobile +The QuickSurveys extension displays and gathers data via EventLogging for configured surveys in both desktop and mobile. -Installation ------------- - -Add the following to your LocalSettings.php file: wfLoadExtension( 'QuickSurveys' ); - -Example Survey Configuration ------------- -``` -<?php -/* Example QuickSurveys config */ -$wgQuickSurveysConfig[] = array( - // Survey name - 'name' => 'example', - // Internal or external link survey - 'type' => 'internal', - // Survey question message key - 'question' => 'ext-quicksurveys-example-question', - // Possible answer message keys for positive, neutral, and negative - 'answers' => array( - 'ext-quicksurveys-example-answer-positive', - 'ext-quicksurveys-example-answer-neutral', - 'ext-quicksurveys-example-answer-negative', - ), - // Which schema to log to - 'schema' => 'QuickSurveysResponses', - // Percentage of users that will see the survey - 'coverage' => '50', - // Is the survey enabled - 'enabled' => false, - // For each platform (desktop, mobile), which version of it is targeted (stable, beta, alpha) - 'platform' => array( - 'desktop' => array( 'stable' ), - 'mobile' => array( 'stable', 'beta' ), - ), -); -``` -You can enable insecure external surveys by enabling `wgQuickSurveysRequireHttps` however this is discouraged. -This will allow you to run a survey from an external website that runs only on http. +See documentation at https://www.mediawiki.org/wiki/Extension:QuickSurveys. -- To view, visit https://gerrit.wikimedia.org/r/349258 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I21eceb7f967e3e641c8b55513bbfe6dafdc118e0 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/QuickSurveys Gerrit-Branch: master Gerrit-Owner: Bmansurov <[email protected]> Gerrit-Reviewer: Jdlrobson <[email protected]> Gerrit-Reviewer: jenkins-bot <> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
