Page MenuHomePhabricator

Create Newsletter Extension Help page
Closed, ResolvedPublic

Description

https://www.mediawiki.org/wiki/Extension:Newsletter contains basic information about this extension and information to enable on a wiki. However, proper Help documentation is missing. Let's fix this!

Create https://www.mediawiki.org/wiki/Help:Extension:Newsletter including:

  • Introduction (first paragraph)
  • Users
    • Where to find all the newsletters.
    • Subscribe/unsubscribe.
    • Change your preferences for notifications.
  • Publishers
    • Create a newsletter.
    • Publish a new issue.
    • Edit the newsletter information page.
    • Add/remove publishers.
  • Administrators
    • Add/remove subscribers.
    • Delete a newsletter.

(Are there use cases missing for any of these roles?)

If this is too much for a single task, we could split it in four, one for create the page + intro and then one for each role. I can proxy-mentor this task, discussing/evaluating with Google-Code-In-2016 students and finding a proper mentor to resolve them when they are done.

Possible follow-up tasks once this one is completed (that I could also proxy-mentor):

  • Add screenshots for each feature (must be uploaded to Wikimedia Commons).
  • Add translation syntax to the page, so it can be translated. (only if the features / texts are consider stable enough)

Event Timeline

Could this be split into a bunch of GCI tasks? Obviously, very good knowledge of English language and its proper spelling && previous experience with user documentation && links to examples of good user docs (and why they are good) would be needed...

@Qgil,
The beginnings of this page are here. https://www.mediawiki.org/wiki/Help:Extension:Newsletter. Please take a look when you can and leave feedback. I will continue to improve this!
Thanks!

Very good! After a first read, the only big question mark I have is that "User rights" section in the middle of the instructions. If that section belongs to that page, it would be better placed at the end. However, I am not even sure that section belongs to that page, since configuration of user rights is an action that only can be set when configuring the extension in a wiki, and therefore it would be better placed in https://www.mediawiki.org/wiki/Extension:Newsletter

By the way, is https://www.mediawiki.org/wiki/Extension:Newsletter linked from anywhere in that page?

There are other details here and there, but I think those are minor and could be left out of the GCi required work.

Very good! After a first read, the only big question mark I have is that "User rights" section in the middle of the instructions. If that section belongs to that page, it would be better placed at the end. However, I am not even sure that section belongs to that page, since configuration of user rights is an action that only can be set when configuring the extension in a wiki, and therefore it would be better placed in https://www.mediawiki.org/wiki/Extension:Newsletter

I'm not sure. I think it would be useful for people to see what rights they need to be able to do certain things. However, they are described on the extension page, and the user will probably get an error if they can't do something, so... I guess this can be further discussed. @01tonythomas What do you think? For now, I will move it to the end of the page.

By the way, is https://www.mediawiki.org/wiki/Extension:Newsletter linked from anywhere in that page?

Will do that now.

There are other details here and there, but I think those are minor and could be left out of the GCi required work.

I can still fix those, if you want me to. :)

Task on the GCI site approved as per Quim's comment in T154222#2923210. I'll leave it to Tony and Quim here in Phab to resolve or not yet.

Not sure if I should close this thing down, but amazing job @MtDu

Yes, let's close it. The page is good and further improvements can be done in the regular wiki way. Thank you very much @MtDu !

MtDu claimed this task.

General consensus seems to agree that this is resolved. Let me know if any updates are needed.
Thanks!