jenkins-bot has submitted this change and it was merged.

Change subject: Update README with better explanation and instructions
......................................................................


Update README with better explanation and instructions

This patch expands the README to provide more detailed information about the
features offered by this extension and instructions for setting it u.

Change-Id: I74f7f3fb48c2649c89834b51ef59ed3d164a7483
---
M README
1 file changed, 13 insertions(+), 2 deletions(-)

Approvals:
  Ori.livneh: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/README b/README
index 716c4ad..965958d 100644
--- a/README
+++ b/README
@@ -1,13 +1,24 @@
 extensions/GettingStarted
 https://www.mediawiki.org/wiki/Extension:GettingStarted
 
-The GettingStarted page creates a new special page, Special:GettingStarted,
-that is automatically shown on signup.  It can also be visited later at any 
time.
+The GettingStarted extension
+* Creates a new special page, Special:GettingStarted,
+  that is automatically shown on signup, and users can visit it at any time.
+* Maintains lists of pages that need easy editing work based on article
+  categories such as 'Category:All articles needing copy edit'
+* Special:GettingStarted presents these tasks; if the user clicks one, it shows
+  an article in that category with a taskbar that
+  - invites the user to fix the article,
+  - offers to show help (using GuidedTours),
+  - links to another article in the same task.
+  - allows the user to choose an alternate task/category.
 
 To use:
 * Put the extension files in your extension directory
 * Add the following line to your LocalSettings.php
 require_once( "$IP/extensions/GettingStarted/GettingStarted.php" );
+* Categorize some wiki articles in the main namespace with the categories in
+  $wgGettingStartedTasks.
 * Create a new user to test.
 
 Dependencies

-- 
To view, visit https://gerrit.wikimedia.org/r/73994
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I74f7f3fb48c2649c89834b51ef59ed3d164a7483
Gerrit-PatchSet: 2
Gerrit-Project: mediawiki/extensions/GettingStarted
Gerrit-Branch: master
Gerrit-Owner: Spage <[email protected]>
Gerrit-Reviewer: Mattflaschen <[email protected]>
Gerrit-Reviewer: Ori.livneh <[email protected]>
Gerrit-Reviewer: Swalling <[email protected]>
Gerrit-Reviewer: jenkins-bot

_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to