Page MenuHomePhabricator

[Documentation] Update and improve docs for Adiutor tool
Open, LowPublic

Description

This task involves UPDATING and IMPROVING on-wiki documentation for the Adiutor tool.

This task was filed as part of the Wiki Mentor Hackathon 2025, but anyone can work on it.

This tool already has documentation, but the creators welcome contributions, and would like the docs to align with the https://www.mediawiki.org/wiki/Documentation/Tool_doc_template

Steps:

Explore the tool: https://meta.wikimedia.org/wiki/Adiutor

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
  • Use the existing tool documentation to create a revised document or set of documents that follow the template format.
  • Reach out to the maintainers of the tool to share your document, and collaborate on how and where to publish it with the existing tool docs.

Use this guide to help you! https://www.mediawiki.org/wiki/Documentation/Tool_docs
Skills Required: Technical writing, MediaWiki editing, Collaboration

Event Timeline

TBurmeister added a project: good first task.
TBurmeister updated the task description. (Show Details)

Thank you for tagging this task with good first task for Wikimedia newcomers!

Newcomers often may not be aware of things that may seem obvious to seasoned contributors, so please take a moment to reflect on how this task might look to somebody who has never contributed to Wikimedia projects.

A good first task is a self-contained, non-controversial task with a clear approach. It should be well-described with pointers to help a completely new contributor, for example it should clearly pointed to the codebase URL and provide clear steps to help a contributor get setup for success. We've included some guidelines at https://phabricator.wikimedia.org/tag/good_first_task/ !

Thank you for helping us drive new contributions to our projects <3

Hi @TBurmeister! :) This is how I setup the documentation so far: progress. Am I on the right track? This is the very first time I'm contributing to Wikimedia's documentation, so I need all the mentoring I can get :)

Hi @CBID2, thanks for wanting to work on this task! It's great that you created a User page and a subpage for your draft. Here are some pointers for next steps:

  • In your draft page, it looks like you may have copied the Markdown version of the template, instead of the wikitext? If you are using VisualEditor, this may not be apparent, but if you switch to editing the wikitext source of the page you can see the markup. In your draft, the section headings are marked with ###, which is what is used in Markdown. Instead, to properly render as headings on the page, they should use wikitext format instead, which uses == for headings.
  • The formatting of some of your lists and paragraphs is also not rendering correctly, probably for the same reason. Take a look at the guides I linked above, and see if you can reformat the steps and substeps in your draft so they appear as orderly lists (either numbered or bulleted).

This is a lot to learn, and you're doing great! After you get comfortable editing the page and working with the formatting, the next step would be to start filling in the placeholder information with real content about the Adiutor tool. We have a technical documentation channel on IRC that you are also welcome to join, and you can ask for help and advice there too:

One other thing I should've mentioned: If you'd prefer to work in Markdown, that is also a welcome form of documentation contribution. You would need to learn / know how to use git-based workflows, and create a draft in a text editor or code editor. You could also try using the built-in tools that services like Github and GitLab offer for editing files in a browser. I can't provide step-by-step guidance for learning to do that, but there are lots of resources on the web that can teach you how to do it.

As an example of this type of doc, here is a link to the current markdown README for the Adiutor tool: https://github.com/wikimedia-gadgets/Adiutor

Hey @TBurmeister! :) I noticed that the tool's documentation mentioned that Adiutor is no longer maintained. I posted a question about in their discussion forum, and I was told by folks in the IRC chat that the maintainer "rage-quit", so I'm kind of lost on where to go from here.

Hey @CBID2, I actually already replied to your question on the talk page. :) I'm the author of Adiutor (the gadget too), and I have not quit maintaining it. I believe you were misinformed. I stepped away from maintaining the extension, not the gadget. Since we are all volunteers and the gadget needs some care, I added the "unmaintained" template because it needs to be ported to ES6 and updated to follow Wikimedia ESLint rules.