Page MenuHomePhabricator

Documentation: Designing components
Closed, ResolvedPublic3 Estimated Story Points

Description

Background/Goal

We need to document all the process to design components in our system. Documentation will be added in the "Contributing" section of the Codex demo.

User stories

  • As a designer I need to know how to design new system components.
  • As a designer I need to know how to redesign existing system components.
  • As a designer I need to know how to design components that “consume” new other components (e.g. a new Card component that uses a new Thumbnail component inside).

Documentation

Acceptance criteria (or Done)

  • Document the process to:
    • Design new components (doc here) [- ] Redesign existing components (doc here)
    • Designing components that “consume” new other components (This was already documented in each of the new and existing components processes)
  • Add documentation in Codex

Event Timeline

bmartinezcalvo renamed this task from Documentation: how to design new components to Documentation: Designing new components.Jul 4 2022, 3:16 PM
Sarai-WMDE renamed this task from Documentation: Designing new components to [DESIGN] Documentation: Designing new components.Sep 2 2022, 12:45 PM
bmartinezcalvo renamed this task from [DESIGN] Documentation: Designing new components to [DESIGN] Documentation: Designing components.Sep 2 2022, 1:54 PM
bmartinezcalvo updated the task description. (Show Details)

Moving to the sprint since it's part of our goals in T313905 and I'm working on it.

The process to design new components has been documented in this Notion page.

@Sarai-WMDE to review the documentation and provided feedback.


The rest of component's design processes described in the task need to be completed (they were started you can find them listed in this Notion):

  • Redesign existing components
  • Design components that consume other new components
  • I believe that Design components that consume other new components should be part of the documentation above. So a section will be added there.
bmartinezcalvo added a subscriber: Volker_E.

I've documented the Design existing components process in Notion and it needs feedback from @Volker_E @Sarai-WMDE

Since both "Designing new components" and "Designing existing components" processes are similar in some section, I've marked with yellow in the "Designing existing components" Notion doc the parts that are relevant important to understand the difference between the new and existing components process. This yellows marks are just for now so you can understand the differences when you read it, but they will be removed once the revision is done.

Captura de Pantalla 2022-10-19 a las 20.29.44.png (1,552×688 px, 604 KB)

ldelench_wmf set the point value for this task to 3.Oct 24 2022, 3:36 PM

The documentation for Designing new components and Redesigning existing components were created in Notion and they are ready to be implemented in Codex.

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

[design/codex@main] docs: Add “Designing new components” documentation

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

Volker_E renamed this task from [DESIGN] Documentation: Designing components to Documentation: Designing components.Dec 8 2022, 9:46 PM

Change 864796 merged by jenkins-bot:

[design/codex@main] docs: Add “Designing new components” documentation

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

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

[mediawiki/core@master] Update Codex from v0.4.0 to v0.4.1

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

Test wiki created on Patch demo by ATomasevich (WMF) using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/cb9ffaffec/w

Change 867727 merged by jenkins-bot:

[mediawiki/core@master] Update Codex from v0.4.0 to v0.4.2

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

bmartinezcalvo moved this task from Incoming to Done on the Design board.

Design sign-off done. All looks good to me!

Test wiki on Patch demo by ATomasevich (WMF) using patch(es) linked to this task was deleted:

https://patchdemo.wmflabs.org/wikis/cb9ffaffec/w/