We should be encouraging WMF feature teams to be writing instrument code in the WikimediaEvents extension unless their codebase is very clearly intended for use only by Wikimedia. This is because the codebases that we host (catch-all term for codebases that we product, maintain, or contribute to) can be installed by third-party wiki admins. Those admins shouldn't have to install instruments and supporting code (the EventLogging, EventStreamConfig, and EventBus extensions) in order to get a feature to work.

Season of Docs 2024 is now complete! I've published an admin guide with the process I used this year to make it easier to run future programs.

Although I haven't tested it, I also came across https://github.com/tomcollins/json-schema-static-docs (via https://gerrit.wikimedia.org/r/c/mediawiki/core/+/1094382), which is a JavaScript tool

Yes, I agree. Thanks!

Thanks for the update, @Ostrzyciel

Sphinx plus the Furo theme is a great option! If you're looking for something simpler, you could consider mkdocs and the material theme, which we use in the Wikimedia Developer Portal. mkdocs seems to have a plugin for rendering doc strings, but I haven't tried it out.

This task is now complete! Aside from a few outliers and cleanup tasks that we'll be tracking separately, all codebases that were publishing JSDuck sites have been migrated to JSDoc 🎉

Declining this since the extension is marked as experimental on mediawiki.org

Hi @Pppery, It doesn't have to be now, but it should be done at some point as part of the undeployment work

Thanks for the decision and the quick patches!

This is now done! See https://doc.wikimedia.org/GuidedTour/master/js/js/index.html. Thanks, @Novem_Linguae!

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

Good idea!

It looks like the documentation updates specified in the task description haven't been done, assuming this change includes user-facing library changes

Great! The workflow docs match that flow.

This project is now complete! See the task description for outcomes.

This is done: https://wikitech.wikimedia.org/wiki/Metrics_Platform/Documentation_maintenance

@Sfaci would you be able to review this one?

This is now done. See https://wikitech.wikimedia.org/wiki/Metrics_Platform#All_pages for new page titles

This page is ready for review: https://wikitech.wikimedia.org/wiki/Metrics_Platform/Glossary Edits and new terms welcome!

Done: https://wikitech.wikimedia.org/w/index.php?title=Metrics_Platform%2FCreate_an_instrument&diff=2239368&oldid=2239293