Page MenuHomePhabricator

Write Jade extension documentation
Open, LowPublic

Description

It should exist at https://mediawiki.org/wiki/Extension:Jade

Write it on mediawiki.org using the standard templates that people use for extensions.

Event Timeline

Halfak created this task.Aug 6 2019, 8:01 PM
Halfak updated the task description. (Show Details)Aug 6 2019, 8:35 PM
Halfak triaged this task as Low priority.Sep 11 2019, 9:13 PM

We might want to have documentation of the labeldata JSON schemas -- either by processing them out of the main schema or breaking the schema up and referencing labeldata docs from the main schema doc.

We made some progress by putting the schemas on wiki. This might not be the best long-term strategy but it's helpful now. See https://www.mediawiki.org/wiki/Extension:Jade/API for schemas related to labeldata and entitydata.

Halfak assigned this task to ACraze.Oct 28 2019, 4:49 PM
Halfak removed projects: Epic, Goal.

I went through the extension docs today and made a few changes:

We should keep iterating on this, will need to add info about the UI and Secondary Integrations (hooks, etc.) as those things wraps up.

I just reviewed this and made some minor additions to the Entity data docs. It sounds like this should go back to "active" rather than "done" so I'm moving it there. Should we split this task so we can resolve the work that has been done?

See T242007: Write Jade API documentation for a dedicated task to the API docs. I also created T242008: Write Jade documentation for secondary integrations for the other bit of work that this task covers.

Wargo removed a subscriber: Wargo.Jan 6 2020, 6:38 PM