Page MenuHomePhabricator

Update component development documentation to reflect new processes and standards
Closed, ResolvedPublic1 Estimated Story Points

Description

T311244 covers significant changes to the component development process meant to ease the burden of contributing to a Codex component. This task covers documenting these changes so that contributors outside the Design Systems Team understand their options for contributing a component.

Note that the structure of the developer docs will likely change with T313940, so we should be mindful of that in whichever of these tasks is completed first (probably this one).


Acceptance criteria

  • The "Code contribution workflow" section of the contributing code docs is updated with the following:
    • A paragraph is added to the "Component addition process" section explaining that this list is the full process, but there are various pathways to contributing to that process, which will be described in the next section.
    • A section is added after the "Component addition process" section called "Code contribution pathways," which explains that contributors have several options available for contributing component code. This includes contributing an partial version of the component as a "WIP component" (with a link to the section on WIP components), a full component that is only demoed in the Vite sandbox, or a full component that is demoed both in the Vite sandbox and on the docs site. The contributor can work with the DST to determine how they want to contribute and what kind of support they might want (e.g. a specific DST member will write the docs site demos once the component development is in-progress or done)
    • The "Patch requirements" section is updated to remove the demo requirement, but add in a requirement that a single demo be added to the Vite sandbox. This should be linked to the section on the Vite sandbox
  • The "Component development" page should be updated to explain the in-development component workflow, and how a component moves from in-development to complete
  • The "Component development" page should be updated to add a section explaining more in-depth how to work with the Vite sandbox

Event Timeline

ldelench_wmf moved this task from Inbox to Up Next on the Design-System-Team board.
Volker_E set the point value for this task to 1.Sep 12 2022, 7:01 PM

Change 831632 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[design/codex@main] docs: Document WIP components and contribution pathways

https://gerrit.wikimedia.org/r/831632

AnneT changed the task status from Open to In Progress.Sep 12 2022, 10:46 PM
AnneT updated the task description. (Show Details)

Change 831632 merged by jenkins-bot:

[design/codex@main] docs: Document WIP components and contribution pathways

https://gerrit.wikimedia.org/r/831632

Change 831947 had a related patch set uploaded (by Eric Gardner; author: Eric Gardner):

[mediawiki/core@master] Update Codex from v0.1.1 to v0.2.1

https://gerrit.wikimedia.org/r/831947

Change 831947 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v0.1.1 to v0.2.1

https://gerrit.wikimedia.org/r/831947

@Catrope this has been merged, but please let me know if you have any suggestions for improving these docs given you implemented the WIP components system

Change 833126 had a related patch set uploaded (by Catrope; author: Catrope):

[design/codex@main] docs: Update WIP components docs

https://gerrit.wikimedia.org/r/833126

Thanks @AnneT, these docs look great! I've uploaded a patch with a few suggestions for improvements.

Change 833126 merged by jenkins-bot:

[design/codex@main] docs: Update WIP components docs

https://gerrit.wikimedia.org/r/833126

Change 849191 had a related patch set uploaded (by VolkerE; author: VolkerE):

[mediawiki/core@master] Update Codex from v0.2.1 to v0.2.2

https://gerrit.wikimedia.org/r/849191

Change 849191 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v0.2.1 to v0.2.2

https://gerrit.wikimedia.org/r/849191