Page MenuHomePhabricator

Announce availability of Codex PHP
Closed, ResolvedPublic1 Estimated Story Points

Description

Now that we've released v0.1.0 of Codex PHP, we should announce its availability more broadly within the Wikimedia community.

Acceptance Criteria

Event Timeline

CCiufo-WMF triaged this task as High priority.
CCiufo-WMF moved this task from Inbox to Needs Refinement on the Design-System-Team board.
CCiufo-WMF updated the task description. (Show Details)
CCiufo-WMF updated the task description. (Show Details)

Draft:

The Design System Team has been working in partnership with community developers to provide a standalone library for generating Codex-styled HTML markup in PHP (phab:T373708). Today we are announcing that it is available in Composer (v0.2.0 at time of this writing) for general use in extensions, and will soon be made available for use in MediaWiki core (phab:T379662).

We hope this will simplify the process for WMF and community developers to use Codex components in their projects, regardless of whether or not they are presenting rich JS applications to their users. A special thank you to Doğu for initiating this effort and contributing the bulk of the code.

I think this is good, but I'd recommend updating some links.

The text "standalone library" can link directly to the Gerrit repo, while the text "available in Composer" can link to the library's page in Packagist (which is where someone using Composer would get this from). And maybe a link to the docs at the end.

Here's a slight modification of the above:

The Design System Team has been working in partnership with community developers to provide a standalone library for generating Codex-styled HTML markup in PHP (phab:T373708). Today we are announcing that it is available in Composer (v0.2.0 at time of this writing) for general use in extensions, and will soon be made available for use in MediaWiki core (phab:T379662).

We hope this will simplify the process for WMF and community developers to use Codex components in their projects, regardless of whether or not they are presenting rich JS applications to their users. A special thank you to Doğu for initiating this effort and contributing the bulk of the code.

For more information, check out the Codex PHP documentation.

@egardner that looks good to me. Are you good to post to wikitech-l? If so, remember to link the phab tasks.

I can make sure it gets to Tech News and the new Community Newsletter.

Here's the final text of the email I sent out:

Hi everyone–

This is an information-only message; no action is required.

We’re excited to announce that Codex, the design system for Wikimedia, now has an implementation in PHP!

The Design System Team has been working in partnership with community developers to provide a standalone library for generating Codex-styled HTML markup in PHP (T373708). Today we are announcing that it is available in Composer (v0.2.0 at time of this writing) for general use in extensions and Toolforge apps (with the caveats that usually apply to early-stage software); eventually, it will also be made available for use in MediaWiki core (T379662).

We hope this will simplify the process for WMF and community developers to use Codex components in their projects, regardless of whether or not they are presenting rich JS applications to their users. A special thank you to Doğu for initiating this effort and contributing the bulk of the code.

For more information, check out the Codex PHP documentation. Extensive docs and demos for Codex proper can be found at https://doc.wikimedia.org/design-codex-php/main/index.html.

Best,

Eric Gardner and the Design System Team