Page MenuHomePhabricator

Software architecture documentation maintainability bot (read only)
Closed, DeclinedPublic

Description

Idea to follow change event that have been done to the source files within some tasks, and indicate those changes to the users of documentation hosted on the mediawiki.org

Event Timeline

Milksh created this task.Apr 16 2015, 3:32 PM
Milksh claimed this task.
Milksh raised the priority of this task from to Medium.
Milksh updated the task description. (Show Details)
Milksh moved this task to Backlog on the Phabricator-Bot-Requests board.
Milksh added a subscriber: Milksh.
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptApr 16 2015, 3:32 PM
Milksh set Security to None.Apr 16 2015, 3:32 PM

Thanks!
Could you please elaborate? What does "indicate those changes to the users of documentation hosted on the mediawiki.org" actually mean? How to identify these "users of documentation" and how to "indicate" exactly?
I assume you are actively working on this?

Currently mediawiki.org contains description for the key files of mediawiki source code (http://www.mediawiki.org/w/index.php?title=Category:MediaWiki_code&pageuntil=LogPager.php%0ALogPager.php#mw-pages). Tracking changes to this files via Phabricator allows us to track who made the change to which file in context of which task. Based on this information another bot for mediawiki.org could updates special properties on the WikiPage for each separate file of mediawiki source code. That might help to indicate to the maintainers of mediawiki.org which pages have to be updated.

I think I get the idea, but could you provide one specific example with the corresponding Phab task, codebase file, and "special properties on the wikipage" affected?

Are you actively working on this?

Yes, we work on this as part of university project, in particular Master Thesis (https://wwwmatthes.in.tum.de/pages/gtwm36bbm8t1/Master-s-Thesis-Ankitaa-Bhowmick). We would like to come up with some results until the Wikimedia Hackaton which is going to take place in Lyon in the end of May. I will come up with a specific example within one day. Maybe I will also have to specify my plan in detail to Quim Gil and S Page.

Aklapper added a subscriber: Spage.

Ah, thanks for the information! Awesome. CC'ing @Spage here as this touches documentation.

I've been responding on various private e-mail threads. I think a bot that notes what needs to be updated is interesting, especially if it could, for example, insert/provide/link to a git log of changes to relevant files since the wiki page was last significantly changed.

However, ideally the software should Be Bold and update documentation itself. To me that means (this is an incomplete list)

Aklapper lowered the priority of this task from Medium to Low.Aug 8 2016, 11:23 AM

@Milksh:
I'm still not entirely sure which role Phabricator is supposed to play here - could you maybe clarify?
Would you want a bot to create some task in Phabricator when code files changed and on-wiki documentation needs updates?
Or would you want a bot to add a template / info box on-wiki about outdated documentation when code files changed?
Asking as those options sound like very different things to me.

Also, are there any updates to share, one year later? Thanks! :)

Aklapper changed the task status from Open to Stalled.Sep 23 2016, 1:52 PM

@Milksh: Any updates?

Aklapper closed this task as Declined.Dec 21 2016, 6:03 AM

Unfortunately closing this report as no further information has been provided.
@Milksh: Please reopen this report (by changing its status) after you have provided the information asked for and if this still requested. Thanks!

Restricted Application removed a subscriber: Liuxinyu970226. · View Herald TranscriptDec 21 2016, 6:03 AM