Page MenuHomePhabricator

Update "Component addition process" documentation in Codex Demo
Closed, ResolvedPublic

Description

Background/Goal

The fact that a component already exists in previous libraries (WVUI, WiKit or OOUI) or is documented in the Design Style Guide shouldn't be interpreted as a green light for implementation by Codex code contributors.

We should update the "Component addition process" section with the info collected in this doc.

Documentation

All the Contribution Guidelines documentation is being collected and updated in his doc.

Questions

  1. Regarding section '5. Demo the component': We might need to add more guidance. How might contributors know what the component demo page should look like? Should the structure of the demo page be specified in the component task? Or should we ask contributors to check how similar components are demoed and to reproduce existing structures?

Acceptance criteria (or Done)

Event Timeline

STH updated Other Assignee, added: ldelench_wmf.
STH added a subscriber: ldelench_wmf.

Thank you @Sarai-WMDE! Will review this with @ldelench_wmf and formalize the contribution process including which board these columns should exist on

New component, bug or component improvement tickets should be added to the 'Needs Triage (Incoming Requests)' column in the Codex Phabricator Workboard.

Agree with what this says, but the workboard linked is the DST board, which should not be the primary place for codex tasks to be processed. I've been discussing this elsewhere in the context of the recent changes, but we should not codify this officially in the codex docs until the final process is figured out, and that process should not be using the DST board, so I suggest holding off on this task

Sarai-WMDE renamed this task from Update Contributing code documentation in Codex Demo to Update Component addition process documentation in Codex Demo.Jun 2 2022, 10:33 AM
Sarai-WMDE updated the task description. (Show Details)
bmartinezcalvo renamed this task from Update Component addition process documentation in Codex Demo to Update "Component addition process" documentation in Codex Demo.Jun 2 2022, 10:52 AM
bmartinezcalvo updated the task description. (Show Details)
bmartinezcalvo updated the task description. (Show Details)

Moving to sprint board since it we're including this as part of the scope for T307924

ldelench_wmf added a subscriber: bmartinezcalvo.

Hey @bmartinezcalvo , let me know if this work should not be assigned to you. Thanks!

Hey @bmartinezcalvo , let me know if this work should not be assigned to you. Thanks!

@ldelench_wmf I worked on the firs acceptance criteria of the task where I collected all the info in the doc to update it later in Codex. I delete the assignment from me since I think someone from development should update it there since they control Codex, but if I can update it please show me how to do this and I will help with this.

From the comment given by Lauren in the document, this task is blocked by T309417 T310627.

The documentation should not be updated until the above-linked stories are completed and the link of the template can be added in the documentation (or so the comments in the document states)

From the comment given by Lauren in the document, this task is blocked by T309417 T310627.

The documentation should not be updated until the above-linked stories are completed and the link of the template can be added in the documentation (or so the comments in the document states)

As the current Contribution guidelines in Codex are confusing and they are giving us some problems with the contributors (specially the Component addition process where it's currently explained that our Source of Truth is the DSG instead of our Figma spec sheets) what if we update at least this section and then we update the template link and info when we finish these other tasks?

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

[design/codex@main] docs: Update intro and contributing guidelines

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

We agreed in today's task refinement meeting that we'd like to update the contributing guidelines on the docs site ASAP to remove current erroneous information, and that we can add links to the task templates once they're ready.

You can see the updated docs site here

Note that I made a few updates, especially to the component addition process section, for the sake of brevity and clear, informal language. I wanted to make sure that the section wasn't so long that people won't read it, and I wanted to make some of the language more direct e.g. "Do this" instead of "you should make sure to..."

Change 807198 merged by jenkins-bot:

[design/codex@main] docs: Update intro and contributing guidelines

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

@AnneT thank your for updating the info in Codex!

Some feedback:

1. Create a new component task in Phabricator.
I would include the template link, at least the one we currently use since users will need a template to create their tasks. Wee can update it with the new one created in the Epic template once we have it. Then I would inlcude:

"You can reuse this template to create a component task in case it is missing."

2. Gather relevant design specs.

I would include the part where we explain that we prepare the spec sheets in the Codex library or in exploration files. This info is important since when we create new components they are not in the Codex Figma library until they are created in the Codex demo. For this reason when we create new components we always prepare first the spec sheet in a exploration file where we work all the versions (read this comment in the doc).

3. Ready for development. All right! ✅

4. Build the component

I would include here a more accessible language and I would use "read the Unit section" instead "see the Unit section" (read this doc comment)

5. Demo the component.

Same as above, I would update "See" with "Read" or "Learn".

Hey @AnneT , wanted to check and see if this task was still in progress, or if it would be helpful to break down further? Thanks!

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

[design/codex@main] docs: Add links to task templates and explain component scoping process

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

Change 816855 merged by jenkins-bot:

[design/codex@main] docs: Add links to task templates and explain component scoping process

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

I've incorporated Bárbara's latest feedback, so I'm closing this!

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

[mediawiki/core@master] Update Codex from v0.1.0-alpha.9 to v0.1.0-alpha.10

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

Change 823725 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v0.1.0-alpha.9 to v0.1.0-alpha.10

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