guardian / guardian/dotcom-rendering
[SPIKE]: Resolve PA team name mappings in frontend
- Dominant language
- TypeScript
- Stars
- 274
- Forks
- 34
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 121
Description
Across DCAR, we override some team names provided by PA to match The Guardian's style guide:
https://github.com/guardian/dotcom-rendering/blob/bdcd90d17d0d41ab7055293cb8169fa3b8e29e59/dotcom-rendering/src/sportDataPage.ts#L95
This takes care of pages/components/atoms rendered in DCAR, but leaves anything rendered by frontend (e.g. Match Day atom, tables/leagues atoms and embeds etc) still carrying the original team names, which means not all cases are covered by the DCAR override and creates inconsistencies across the website and app where frontend atoms/components are used - see example below:
The purpose of this Issue is to explore how we best resolve this. Some potential (but maybe not all?) options to explore are:
- Changing the names further upstream so they permeate regardless of the platform used to render a component
- Adding a similar override that has been implemented in DCAR to frontend specifically
- Migrating the atoms/components rendered in frontend to DCAR, meaning no override is required in frontend as it no longer renders any affected atoms/components
There may also be other/better options for solving this.
The desired outcome is a recommendation for how we solve this as quickly as possible in the near-term as well as what a long-term solution might look like if that differs from the more immediate fix.
Contributor guide
Research direction
Read the linked sportDataPage.ts override first, then trace the frontend-rendered Match Day, tables/leagues atoms, and embeds mentioned in the issue. Compare upstream name changes, a frontend override, and migration to DCAR; done means a documented near-term recommendation and a distinct long-term recommendation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100