Implementation of visual testing epic

[corwintines]

This is part of our Testing epic from our Q2 roadmap.

Description

We have implemented support for storybook to do testing on ethereum.org. We would like to be able to catch visual regressions before they reach production, helping us build confidence so that we can improve stability of ethereum.org through a testing suite. The first phase of this will be implementing visual storybook tests on our suite of components.

Below is the list of components in the ethereum.org repo, broken down by Atomic design.

How to contribute

If you’d like to help with adding stories for components, please follow these steps:

1. Read the storybook documentation for the project
2. Leave a comment here asking which component you would ke to work out. We will be going from the top of the list to bottom (Atoms to Pages).
3. We assign you to the file (by adding your handle next to the file name in the list).
   • Read and follow our storybook implementation guide for some tips & guidance.
   • If you were assigned to multiple files then create a separate PR for each component. It will make the testing and review process much simpler and more organized.
4. Once you finish it (PR merged), we’ll mark it as done.
5. Repeat!

---

Components

Atoms

In Atomic Design, as in chemistry, atoms are the basic elements that help inform everything. In the world of web applications, atoms are the foundational elements, such as HTML tags, fonts, animations, and color palettes. Web design “atoms” can also be less concrete. Examples include buttons or forms.

Typeography

Beta Give feedback

1. Headings
2. @chakra-ui/components/Link
3. Text

Media & icons - All visual references used in ethereum.org

Beta Give feedback

1. Avatars
2. Icons
3. Create story for Logo component #13067
   Status: Stale feature ✨ +2
   
4. Create story for MergeInfoGraphic #13242
   Status: Stale dev required testing +3
   
5. TranslationChartImage #13734
   needs triage 📥 +1
   
6. Create story for Trilemma component #13250
   Status: Stale testing +2
   

Forms - Base html components used in forms

Beta Give feedback

1. Buttons
2. Checkbox
3. Input variations and state
4. Radio
5. Select
6. Slider
7. Switch

Molecules

Molecules are the next-largest building block. Created by the joining of different atomic elements, molecules are complex by nature. Because they’re the product of various atoms, though, it’s possible to break them down, conceptually, into UI elements that are easier to digest. Examples of web design molecules include the things that become the backbone of the larger design system, such as form labels or input field.

Navigation - components used to navigate to other pages. Inner or external to ethereum.org.

Beta Give feedback

1. Create story for BannerNotification component #14152
   dev required hacktoberfest +2
   
2. Create story for DismissableBanner component #13044
   feature ✨ good first issue help wanted +3
   
3. Breadcrumbs
4. Create story for CallToContribute component #13733
   +0
   
5. Create story for Contributors component #13878
   Status: Stale dev required +2
   
6. Create story for DeveloperDocsLinks component #13879
   Status: Stale dev required +2
   
7. DocLink
8. DocsNav
9. LeftNavBar
10. Links
11. MergeArticleList
12. TableOfContents #13210
    Status: Stale dev required testing +3
    
13. Sidenav DS implementation - SideNav #13063 @pettinarip

Display content - components used to show data/information primary

Beta Give feedback

1. ActionCard
2. Create story for AssetDownload component #13045
   Status: Stale feature ✨ good first issue help wanted +4
3. Create issue for BannerGrid components #13046
   Status: Stale feature ✨ good first issue help wanted +4
   
4. BeaconChainActions
5. BoxGrid
6. BugBountyCards
7. Callout
8. Card
9. CardList
10. Codeblock
11. CommunityEvents
12. ContributorsQuizBanner
13. CopyToClipboard
14. DataProductCard
15. EnergyConsumptionChart
16. EnvWarningBanner
17. EventCard
18. FeedbackCard
19. FileContributors
20. GitStars
21. HorizontalCard
22. InfoBanner
23. IssuesList
24. Layer2ProductCard
25. Leaderboard
26. LearningToolsCardGrid
27. GlossaryDefinition
28. NetworkUpgradeSummary
29. Layer2Onboard
30. MarkdownImage
31. MatomoOptOut
32. Create stories for MdComponents #13047
    feature ✨ good first issue help wanted question ❓ +4
    
33. OrderedList
34. ProductCard
35. ProductDisclaimer
36. ProductList
37. RandomAppList
38. Progress
39. Create story for Quiz components #13048
    feature ✨ good first issue help wanted +3
40. RoadmapActionCard #13211
    Status: Stale dev required testing +3
    
41. RoadmapImageContent
42. SocialListItem
43. StablecoinBoxGrid
44. StablecoinsTable
45. Stat
46. StateErrorMessage
47. Tables
48. Tags
49. TitleCardList
50. TranslationBanner
51. TranslationBannerLegal
52. TranslationLeaderboard
53. TutorialMetadata
54. TutorialTags
55. UpgradeStatus
56. UpgradeTableOfContents
57. Youtube

Disclosure content - components used to hide and show content useing interactive functions

Beta Give feedback

1. Accordion
2. ButtonDropdown
3. StablecoinAccordion
4. Switch
5. Tabs

Overlay content - components used on top from the main page

Beta Give feedback

1. CodeModal
2. ExpandableCard
3. ExpandableInfo
4. FeedbackWidget
5. GlossaryTooltip
6. Modal
7. Popover
8. Tooltip
9. TooltipLink

Action feedback - components used to show feedback of a user action

Beta Give feedback

1. Alerts

Organisms

Atoms combine to form molecules, and groups of molecules form organisms. In the world of Atomic Design, organisms are the UI elements that shape both the appearance and functionality of a website. They’re also the elements that start to impact user interface. The way a developer arranges molecules informs the site experience and the complexity of the finished product. Examples of organisms include logos, search fields, and main navigation which together may form a header organism.

Tasks

Beta Give feedback

1. Create stories for Header components #13050
   Status: Stale feature ✨ good first issue help wanted +4
2. Footer
3. MainArticle
4. Hero
5. Remove unused component VideoIframe #13055
   +0

Snippets - composed components has use cases or references to display the same type of data

Beta Give feedback

1. Create stories for Simulator components #13052
   Status: Stale feature ✨ good first issue help wanted +4

Templates

At this phase of the Atomic Design process, we start to break with the chemistry analogy and shift back into the lexicon of front-end development, as a whole. Templates, then, are “organisms” strung together at the page-level or beyond. Templates, online atoms, organisms, and molecules, are highly concrete. They provide a fixed context for the more abstract pieces to fit and are responsible for pulling the site together into something resembling its final form. An HTML wireframe is an excellent example of a template.

Templates - base pages to be used in creation of new content. They incorporate all of the components mandatory for the page

Beta Give feedback

1. Docs
2. Roadmap [Blocked on refactor]
3. RootLayout (BaseLayout)
4. Staking [Blocked on refactor]
5. Static
6. Tutorial
7. Upgrade [Blocked on refactor]
8. Usecases [Blocked on refactor]

Pages

Pages, finally, are the final element of Atomic Design. According to Frost himself, pages are the specific instances of templates. Pages are the most tangible element of all and are the places users spend most of their time. They’re also one of the most essential phases of the Atomic Design process since the final iteration of pages is where developers get to see whether the entire design system is effective or not. In short, the final appearance of the pages dictates whether the product design is ready to launch, or whether the developer needs to loop back and make changes to earlier UI design elements.

Special cases - Pages that are unique and require custom made components

Beta Give feedback

1. Create stories for FindWallet components #13053
   Status: Stale feature ✨ good first issue help wanted +4
   
2. Create stories for Staking components #13054
   Status: Stale feature ✨ good first issue help wanted +4

Pages - List of pages with final content to showcase and inspire

Beta Give feedback

1. / (homepage)
2. /404
3. /assets
4. /bug-bounty
5. /community
6. /contributing/translation-program
7. /contributing/translation-program/acknowledgements
8. /contributing/translation-program/contributors
9. /dapps
10. /developers
11. /developers/learning-tools
12. /developers/local-environment
13. /developers/tutorials
14. /eth
15. /gas
16. /get-eth
17. /layer-2
18. /learn
19. /quizzes
20. /roadmap
21. /roadmap/vision
22. /run-a-node
23. /stablecoins
24. /staking
25. /staking/deposit-contract
26. /wallets
27. /wallets/find-wallet
28. /what-is-ethereum

---

How to contribute

If you’d like to help with adding stories for components, please follow these steps:

1. Read the storybook documentation for the project
2. Leave a comment here asking which component you would ke to work out. We will be going from the top of the list to bottom (Atoms to Pages).
3. We assign you to the file (by adding your handle next to the file name in the list).
   • Read and follow our storybook implementation guide for some tips & guidance.
   • If you were assigned to multiple files then create a separate PR for each component. It will make the testing and review process much simpler and more organized.
4. Once you finish it (PR merged), we’ll mark it as done.
5. Repeat!

[TommWolf]

For me it does not matter on which component I will work. I simply want to help.

[corwintines]

Awesome, thanks @TommWolf!

I created an issue for the Logo component: #13067

If you comment in this issue, ill assign you :)

[TylerAPfledderer]

@corwintines noting here that I have #12960 up for RootLayout (now becoming BaseLayout), and looking at building a consolidated layout as discussed previously with Pablo and Nuno.

[wackerow]

Started attaching the sub-task Issues as "milestones" for this epic (13043) to help track

[pettinarip]

Hey @corwintines could you assign me the TableOfContents? wip #13156

[corwintines]

@pettinarip created an issue and assigned. Will update description over there.

[Baystef]

Hi @corwintines , I'll like to be assigned the MergeInfoGraphic story. Thanks

[tomasgrusz]

Hey, would love to help out with this, happy to start working on Form components (e.g. Buttons, Inputs, Checkbox,..) one by one.

[TylerAPfledderer]

Hey, would love to help out with this, happy to start working on Form components (e.g. Buttons, Inputs, Checkbox,..) one by one.

Hey @tomasgrusz ! Those components already have stories. They are shown as checked and only here for the organization of the list :)

[tomasgrusz]

Hey, would love to help out with this, happy to start working on Form components (e.g. Buttons, Inputs, Checkbox,..) one by one.

Hey @tomasgrusz ! Those components already have stories. They are shown as checked and only here for the organization of the list :)

My mistake @TylerAPfledderer. In that case, I'm happy to pick up any of the remaining Atom components so that we can have all of them done.

[corwintines]

@tomasgrusz I pinged you in #13067 just now. If you are open for it, will assign :)

[Baystef]

@wackerow I'll like to be assigned the TranslationChartImage story. Please help create an issue for it and assign it to me

[Baystef]

@wackerow @corwintines I'll like to work on the CallToContribute component under Molecules.

[corwintines]

Creating those issues now for you @Baystef. Thank you for your patience and taking those on!

[Baystef]

@corwintines Please assign Contributors and DeveloperDocsLinks to me. Thanks

[prxjwal]

@corwintines I would like to work on BannerNotification pls assign

[corwintines]

Will create the issue for you now @prxjwal