Blog Post:55: Difference between revisions

From MWStake
Jump to navigation Jump to search
m (not up yet)
()
 
Line 24: Line 24:
== Story time: A morality tale about the [[mw:Extension:MagicNumberedHeadings|MagicNumberedHeadings extension]]==
== Story time: A morality tale about the [[mw:Extension:MagicNumberedHeadings|MagicNumberedHeadings extension]]==


This past week, I was going to update a wiki and needed to make sure the [[mw:Extension:MagicNumberedHeadings|MagicNumberedHeadings extension]] was up-to-date.  I noticed that there used to be a Gerrit-hosted repository for the extension, but the repository and the page itself were gone.
This past week, Mark was going to update a wiki and needed to make sure the [[mw:Extension:MagicNumberedHeadings|MagicNumberedHeadings extension]] was up-to-date.  He noticed that there used to be a Gerrit-hosted repository for the extension, but the repository and the page itself were gone.


I had a copy of the extension in Github, so this wouldn't matter too much, but, upon investigation, there turned to be some good lessons and a bit of a reminder for me.
There was a previous copy of the extension in Github, so this wouldn't matter too much, but, upon investigation, there turned to be some good lessons and a bit of a reminder.


Initially, when I came across it, the extension [https://www.mediawiki.org/w/index.php?title=Extension:MagicNumberedHeadings&oldid=2877235 stored its code on the mediawiki.org]. I was using git to deploy code on this wiki, so I needed a repository.  I set one up at [https://github.com/hexmode/mediawiki-MagicNumberedHeadings github] and forgot about it (except when [https://github.com/hexmode/mediawiki-MagicNumberedHeadings/commit/26952d4d923a6c3af42aa6218e9581c59f0a4911 I needed to maintain it]).
Initially, the extension [https://www.mediawiki.org/w/index.php?title=Extension:MagicNumberedHeadings&oldid=2877235 stored its code on the mediawiki.org]. Mark uses git to deploy code on, so he needed a repository.  He set one up at [https://github.com/hexmode/mediawiki-MagicNumberedHeadings github] and forgot about it (except when [https://github.com/hexmode/mediawiki-MagicNumberedHeadings/commit/26952d4d923a6c3af42aa6218e9581c59f0a4911 he needed to maintain it]).


Shortly after importing the extension into github and doing some fixups, I [https://www.mediawiki.org/w/index.php?title=Gerrit/New_repositories/Requests/Entries&diff=prev&oldid=2444236&diffmode=source requested a gerrit repository be created] from my github repo.  Again, though, I didn't update mediawiki.org to point to the repo.  And I forgot about the gerrit repository, even when I wanted to later fix the code like I did [https://github.com/hexmode/mediawiki-MagicNumberedHeadings/commit/26952d4d923a6c3af42aa6218e9581c59f0a4911 this past June].  If I remembered that I had made a gerrit repo, I would have seen that [https://gerrit.wikimedia.org/r/c/mediawiki/extensions/MagicNumberedHeadings/+/558745 <tt>@legoktm</tt> had already fixed it].
Shortly after importing the extension into github and doing some fixups, he [https://www.mediawiki.org/w/index.php?title=Gerrit/New_repositories/Requests/Entries&diff=prev&oldid=2444236&diffmode=source requested a gerrit repository be created] from the github repo.  Again, though, he didn't update mediawiki.org to point to the repo.  And he forgot about the gerrit repository, even when he wanted to later fix the code like he did [https://github.com/hexmode/mediawiki-MagicNumberedHeadings/commit/26952d4d923a6c3af42aa6218e9581c59f0a4911 this past June].  If he remembered that he had made a gerrit repo, or documented its creation on MediaWiki.org, he would have seen that [https://gerrit.wikimedia.org/r/c/mediawiki/extensions/MagicNumberedHeadings/+/558745 <tt>@legoktm</tt> had already fixed it].


During all this, [https://www.mediawiki.org/w/index.php?title=Extension:MagicNumberedHeadings&diff=prev&oldid=2877235&diffmode=source the mediawiki.org page went unmodified except for a small typo fix up until last month] when my friend [https://www.semantic-mediawiki.org/wiki/User:Kghbln Karsten Hoffmeyer] came across it, saw the code on the page had not been updated since 2016, noticed it didn't work with [https://phabricator.wikimedia.org/T200247 the newer MagicWordFactory] and [https://www.mediawiki.org/w/index.php?title=Extension:MagicNumberedHeadings&diff=next&oldid=2877235&diffmode=source archived it].
During all this, [https://www.mediawiki.org/w/index.php?title=Extension:MagicNumberedHeadings&diff=prev&oldid=2877235&diffmode=source the mediawiki.org page went unmodified except for a small typo fix up until last month] when [https://www.semantic-mediawiki.org/wiki/User:Kghbln Karsten Hoffmeyer] came across it, saw the code on the page had not been updated since 2016, noticed it didn't work with [https://phabricator.wikimedia.org/T200247 the newer MagicWordFactory] and [https://www.mediawiki.org/w/index.php?title=Extension:MagicNumberedHeadings&diff=next&oldid=2877235&diffmode=source archived it].


And, so it happened that this past March 28th, a diligent MediaWiki.org administrator created a task to [https://phabricator.wikimedia.org/T248758 archive the MagicNumberedHeadings gerrit repo].  (I asked for it to be un-archived.)
And, so it happened that this past March 28th, a diligent MediaWiki.org administrator created a task to [https://phabricator.wikimedia.org/T248758 archive the MagicNumberedHeadings gerrit repo].  (Mark asked for it to be un-archived.)


All this because I had did not update the extension page on MediaWiki.org originally.
All this because Mark did not update the extension page on MediaWiki.org originally.


Documentation is important! How many times do I have to tell me that?
Documentation is important! How many times do we need to learn that?


==3 point buzzer beater==
==3 point buzzer beater==


Bryan showed us how the [[mw:Extension:Flex_Diagrams|Flex Diagrams]] extension allows you to easily create and edit [https://discoursedb.org/w/index.php?title=BPMN:Hi&action=editdiagram BPMN diagrams], [https://discoursedb.org/w/index.php?title=Gantt:Project_ATLAS&action=editdiagram Gantt charts], and [https://discoursedb.org/w/index.php?title=Mermaid:Sample_diagram&action=editdiagram Mermaid diagrams].
Bryan showed us how the [[mw:Extension:Flex_Diagrams|Flex Diagrams]] extension allows you to easily create and edit [https://discoursedb.org/w/index.php?title=BPMN:Hi&action=editdiagram BPMN diagrams], [https://discoursedb.org/w/index.php?title=Gantt:Project_ATLAS&action=editdiagram Gantt charts], and [https://discoursedb.org/w/index.php?title=Mermaid:Sample_diagram&action=editdiagram Mermaid diagrams].

Latest revision as of 12:53, 7 September 2020

by Mark Hershberger on 4 September 2020 17:47 (EDT)

Tag.png Tags: MediaWiki, News
Person.png People: Bryan Hildebrand, Mark Hershberger

From the recent #mwstake meeting:

One major feature is that Parsoid, a library necessary to use Visual Editor is now written entirely in PHP and both Parsoid and VisualEditor are bundled in the tarball. This means extensions like DiscussionTools can be used without any external dependencies.
  • There is an updated visualization of the pingback statistics using the heartbeat ping: chart.
The new heartbeat ping (from 1.30—October 2018—forward) are showing only new installations instead of accumulating all pings. This explains the sawtooth on the chart.
This CoC will probably replace the technical one, so it would apply to third party MW users who participate in WMF spaces.

Story time: A morality tale about the MagicNumberedHeadings extension

This past week, Mark was going to update a wiki and needed to make sure the MagicNumberedHeadings extension was up-to-date. He noticed that there used to be a Gerrit-hosted repository for the extension, but the repository and the page itself were gone.

There was a previous copy of the extension in Github, so this wouldn't matter too much, but, upon investigation, there turned to be some good lessons and a bit of a reminder.

Initially, the extension stored its code on the mediawiki.org. Mark uses git to deploy code on, so he needed a repository. He set one up at github and forgot about it (except when he needed to maintain it).

Shortly after importing the extension into github and doing some fixups, he requested a gerrit repository be created from the github repo. Again, though, he didn't update mediawiki.org to point to the repo. And he forgot about the gerrit repository, even when he wanted to later fix the code like he did this past June. If he remembered that he had made a gerrit repo, or documented its creation on MediaWiki.org, he would have seen that @legoktm had already fixed it.

During all this, the mediawiki.org page went unmodified except for a small typo fix up until last month when Karsten Hoffmeyer came across it, saw the code on the page had not been updated since 2016, noticed it didn't work with the newer MagicWordFactory and archived it.

And, so it happened that this past March 28th, a diligent MediaWiki.org administrator created a task to archive the MagicNumberedHeadings gerrit repo. (Mark asked for it to be un-archived.)

All this because Mark did not update the extension page on MediaWiki.org originally.

Documentation is important! How many times do we need to learn that?

3 point buzzer beater

Bryan showed us how the Flex Diagrams extension allows you to easily create and edit BPMN diagrams, Gantt charts, and Mermaid diagrams.