Page MenuHomePhabricator

Update new component task template and update links in our DS documentation
Closed, ResolvedPublic

Description

Background/Goal

We have decided to rethink the way we create task hierarchy, and one result is that we would like to get rid of the epic task template for new components, replacing them with something similar but with the acceptance criteria of just the MVP of that component. Then, we'll need to update links to the epic and MVP task template throughout our docs.

New template

Link to the new template

Acceptance criteria (or Done)

Event Timeline

bmartinezcalvo moved this task from Inbox to Needs Refinement on the Design-System-Team board.
Volker_E renamed this task from Update the info about Epic tasks in our DS documnetation to Update the info about Epic tasks in our DS documentation.Feb 14 2023, 11:03 PM
Volker_E added a project: Documentation.
AnneT renamed this task from Update the info about Epic tasks in our DS documentation to Update new component task template and update links in our DS documentation.Feb 16 2023, 4:14 PM
AnneT changed the task status from Open to In Progress.
AnneT claimed this task.
AnneT updated the task description. (Show Details)
AnneT added a subscriber: CCiufo-WMF.

@ldelench_wmf @CCiufo-WMF I've created this new task template for new components; please let me know if you have any suggestions for improvement! Once we agree that this is good enough, I can start updating the links in our docs.

Looks great to me, thanks @AnneT ! For this bit, under Existing Implementations:

Should we link to https://www.mediawiki.org/wiki/Vue.js#Projects_using_Vue.js instead of T272885? Linking to a resolved task might lead folks to think the inventory is outdated.

@ldelench_wmf oh yeah, absolutely! Thanks for thinking of that. I've updated the template link here.

Nice, thanks @AnneT! No other feedback from me.

@ldelench_wmf @CCiufo-WMF I've created this new task template for new components; please let me know if you have any suggestions for improvement! Once we agree that this is good enough, I can start updating the links in our docs.

@AnneT it LGTM too. Just a couple of things to improve:

  1. Could we include in the Acceptance criteria the check to link the Figma spec sheet in the task? Also we could separate the Design and Code sections as we have now in this other task template:

    Design
    • Design the Figma spec sheet and add it in this task
    • Update the component in the Figma library. This step will be done by a DST member.

      Code
    • Implement the component in Codex
  1. The User stories section is missing.

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

[design/codex@main] docs: Update new component task template links

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

@bmartinezcalvo FYI I have opened a patch to update all of the links on the Codex docs site, and have updated the links we have on our mediawiki.org pages. Could you please take care of the governance model links?

Change 890897 merged by jenkins-bot:

[design/codex@main] docs: Update new component task template links

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

@bmartinezcalvo FYI I have opened a patch to update all of the links on the Codex docs site, and have updated the links we have on our mediawiki.org pages. Could you please take care of the governance model links?

@AnneT updated both the Governance model flowchart and documentation.

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

[mediawiki/core@master] Update Codex from v0.6.0 to v0.6.2

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

Change 893051 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v0.6.0 to v0.6.2

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