Page MenuHomePhabricator

[Documentation] Write user docs for WikiBooster tool
Closed, ResolvedPublic

Description

This task involves creating on-wiki documentation for the WikiBooster.

Steps:

Explore the tool: Click the "Go to Tool" button on its Toolhub page.

Note: Please use this wiki-text template: https://www.mediawiki.org/wiki/Documentation/Tool_doc_template

Create on-wiki docs:

  • In your user space, create a new subpage (for example https://meta.wikimedia.org/wiki/User:{YOUR USERNAME}/New_page
  • Write clear user guides (e.g., installation, troubleshooting).
  • Get feedback from another hackathon participant - have them review your documents and provide suggestions.
  • Reach out to the maintainer of the tool to tell them about your documentation and suggest publishing it with the tool. You need to work with the tool maintainer to decide where they want to publish the documentation.

Use this guide to help you! https://www.mediawiki.org/wiki/Documentation/Tool_docs

Skills Required: Technical writing, MediaWiki editing, Toolhub navigation.

Event Timeline

@JorisDarlingtonQuarshie: https://www.mediawiki.org/wiki/Rakennettu_perintömme does not exist, so why create a subpage called https://www.mediawiki.org/wiki/Rakennettu_perintömme/Documentation without a parent page ? What's "/Documentation" good for; do you expect "non-documentation" on the parent page? How many folks at WMA-Hackathon-2025 speak either Finnish or Swedish?
Has this been discussed with the tool maintainer before?

TBurmeister renamed this task from [Documentation] Write user docs for Rakennettu perintömme to [Documentation] Write user docs for WikiBooster tool.Mar 29 2025, 2:35 PM
TBurmeister updated the task description. (Show Details)

Hi team, please post a link to your documentation here so I can assess if the task can be resolved. Thank you!

This comment was removed by Iamgreaced.

Great job from the Team. I’m impressed 👍🏻

This is impressive, kudos to the team!

Great job during the Hackathon, everyone! If you want to keep learning and keep contributing to technical documentation, here are instructions: https://www.mediawiki.org/wiki/Documentation/Contribute.
If you want to reach out to the maintainers of the tool you documented, to talk to them about where to add what you wrote in "official" documentation for the WikiBooster tool, I suggest you should:

Thanks again for your amazing work this weekend.