Page MenuHomePhabricator

[Documentation] Write User Docs for Book Linker Tool
Closed, ResolvedPublic

Description

This task involves creating on-wiki developer documentation for the Book Linker tool.

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

Event Timeline

Eugene233 renamed this task from Write User Docs for Redirect Creator Tool to [Documentation] Write User Docs for Redirect Creator Tool.Mar 29 2025, 9:59 AM
TBurmeister renamed this task from [Documentation] Write User Docs for Redirect Creator Tool to [Documentation] Write User Docs for Book Linker Tool.Mar 29 2025, 3:16 PM
TBurmeister updated the task description. (Show Details)

One page of draft documentation that I found (this may not be the team's final output, and I'm not sure if this contributor was on a different team) https://meta.wikimedia.org/wiki/UrichKllian/New_page_Docs

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 Book Linker tool, I suggest you should start a discussion on their User page: https://en.wikipedia.org/wiki/User_talk:GreenC, or reach out via Github https://github.com/greencardamom.

I have also added them as a subscriber to this task in case communicating on Phab is easier.

Thanks again for your amazing work this weekend.