🎉 UI updates for standardized explorer names, explore tagging, and an `explorer-tiles` component #3158

ikesau · 2024-01-31T21:44:02Z

The UI complement to owid/owid-content#36

Charts page:

Explorer Tiles component:

Explorer page:

Explorer prominent link:

Summary by CodeRabbit

New Features
- Added a new "Explorer Tags" management page in the Admin interface, enabling viewing, editing, and deleting of tags associated with explorers.
- Introduced navigation to the "Explorer Tags" page from the Admin sidebar under the "Explorers" section.
- Added functionality for displaying explorer tiles in articles, including titles, subtitles, and links to charts or data explorers.
- Implemented a new route for fetching all explorer tags.
Enhancements
- Improved explorer page by adding support for an explorerSubtitle.
- Enhanced styling for explorer download links and explorer tiles within articles.
Refactor
- Simplified admin and API router configurations by removing unnecessary code and streamlining route definitions.
- Updated database interactions to support new explorer tags functionality.
- Refactored Gdoc handling to support explorer tiles and improve data processing.
Bug Fixes
- Corrected logic for setting descriptions in ProminentLink component to handle various scenarios more effectively.
Database Changes
- Introduced a migration for creating a new explorer_tags table to manage explorer-tag associations.

coderabbitai · 2024-01-31T21:44:22Z

Walkthrough

The update introduces a comprehensive feature for managing explorer tags within an administrative interface. It includes the creation of a new page for tag management, enhancements to existing components for navigation and display, and backend adjustments for data handling. The changes streamline the process of linking explorers to tags, improve the user interface for managing these associations, and refine data fetching and processing mechanisms across the system.

Changes

File(s)	Change Summary
`adminSiteClient/AdminApp.tsx`, `.../AdminSidebar.tsx`	Added navigation and sidebar entry for the new `ExplorerTagsPage`.
`adminSiteClient/ExplorerTagsPage.tsx`	Introduced a component for managing explorer tags.
`adminSiteServer/adminRouter.tsx`, `.../apiRouter.ts`	Adjusted routes for tag handling and simplified existing routes.
`db/db.ts`, `db/migration/...-ExplorerTags.ts`	Database enhancements for explorer tags, including new functions and a migration for a new table.
`db/model/Gdoc/...`, `packages/@ourworldindata/types/src/gdocTypes/...`	Modified Gdoc handling to support explorer tiles and tags.
`explorer/Explorer.tsx`, `explorer/ExplorerConstants.ts`, `...`	Updated explorer components for tag management and display adjustments.
`site/...`, `baker/...`	Site and baking process updates to accommodate new tag functionalities and explorer tiles.
`packages/@ourworldindata/types/src/index.ts`, `.../utils/src/Util.ts`	Introduced new types and utility functions for handling explorer tiles.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit-tests for this file.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit tests for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository from git and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit tests.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
The JSON schema for the configuration file is available here.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

ikesau · 2024-02-13T21:12:27Z

@coderabbitai review

explorer/Explorer.tsx

adminSiteServer/apiRouter.ts

db/model/Gdoc/rawToEnriched.ts

adminSiteServer/apiRouter.ts

site/gdocs/components/ExplorerTiles.tsx

adminSiteServer/adminRouter.tsx

adminSiteClient/ExplorerTagsPage.tsx

ikesau · 2024-02-13T22:23:50Z

db/model/Gdoc/GdocBase.ts

@@ -554,22 +566,28 @@ export class GdocBase extends BaseEntity implements OwidGdocBaseInterface {
                        title: resolvedTitle,
                        resolvedUrl: `${BAKED_GRAPHER_URL}/${resolvedSlug}`,
                        thumbnail: `${BAKED_GRAPHER_EXPORTS_BASE_URL}/${resolvedSlug}.svg`,
+                        tags: [],


Not doing anything with chart tags atm. Can add them when we need them

mlbrgl

@ikesau I'm seeing a failing test (can repro locally)

…ardization

mlbrgl

It is so nice not to have to thread explorers throughout the codebase, well done! 🙌

Run locally, works as expected 🤝

I don't know how often this'll happen but it might be visually better to align the titles here

Mardown making its way into prominent links (I couldn't go all the way with running mirror_explorers locally so I'm not sure if that would fix it so I'm raising it here)

mlbrgl · 2024-02-14T18:03:47Z

adminSiteClient/AdminSidebar.tsx

+                <ul>
+                    <li>
+                        <Link to="/explorer-tags">
+                            <FontAwesomeIcon icon={faTag} /> Explorer Tags
+                        </Link>
+                    </li>
+                </ul>


probably nothing to change now

this is a bit unexpected - but maybe unavoidable given the git/db limbo. When first encountering this, it gave me the impression that "explorer tags" were different from the regular ones.

Also given how seldom this is going to be used beyond the first tagging effort, it seems like there is a mismatch with the prime real estate this menu item will be permanently using.

Maybe worth considering complementing this with a more contextual link to /explorer-tags on every explorer row?

mlbrgl · 2024-02-14T18:07:40Z

adminSiteServer/adminRouter.tsx

+    return res.send({
+        explorers: await db.getExplorerTags(db.knexInstance()),
+    })


not absolutely necessary now, but maybe wrap in read-only transaction?

db/model/Gdoc/GdocBase.ts

db/model/Gdoc/rawToEnriched.ts

db/db.ts

site/gdocs/components/ExplorerTiles.scss

ikesau · 2024-02-15T16:18:48Z

site/gdocs/components/ExplorerTiles.tsx

+        >
+            {icon}
+            <div className="explorer-tile__text-container">
+                <p className="h3-bold explorer-tile__title">


Add background blur to this

…ardization

github-actions bot assigned ikesau Jan 31, 2024

ikesau mentioned this pull request Feb 13, 2024

Add first batch of tag icons #3191

Merged

ikesau added 8 commits February 13, 2024 21:08

🎉 update explorer title and subtitle display

95627d8

🎉 tags for explorers

adba983

🎉 explorer tiles component

727653b

✨ drop FK constraint for explorer tags, remove "x" from table name

a588142

✨ improve ExplorerTagsPage

34a8d2e

🎉 use explorers from the DB to power gdocs

cc618dc

🎉 explorer tile text wrap

22c4d14

✅ fix lint

37e7c98

ikesau force-pushed the explorer-name-standardization branch from 10026dc to 37e7c98 Compare February 13, 2024 21:09

ikesau changed the title ~~🎉 Update all places where explorerTitle is used to transition to new title format~~ 🎉 UI updates for standardized explorer names, explore tagging, and an explorer-tiles component Feb 13, 2024

ikesau added the coderabbit label Feb 13, 2024

ikesau marked this pull request as ready for review February 13, 2024 21:11

coderabbitai bot reviewed Feb 13, 2024

View reviewed changes

ikesau commented Feb 13, 2024

View reviewed changes

ikesau added 3 commits February 13, 2024 18:30

✨ explorer code review improvements

7cd638b

✨ use explorer subtitles in prominent link

0a4f98d

✨ use better key for ExplorerTile

7ad8265

mlbrgl reviewed Feb 14, 2024

View reviewed changes

ikesau added 3 commits February 14, 2024 12:40

✅ fix explorer-tiles roundtrip test

4b54376

Merge remote-tracking branch 'origin/master' into explorer-name-stand…

f048003

…ardization

✨ enhance explorer tiles CSS, add tag icon support

38875ca

mlbrgl approved these changes Feb 15, 2024

View reviewed changes

ikesau commented Feb 15, 2024

View reviewed changes

site/gdocs/components/ExplorerTiles.scss Show resolved Hide resolved

ikesau commented Feb 15, 2024

View reviewed changes

ikesau added 2 commits February 15, 2024 22:27

✨ explorer-tiles code review fixes

08806e7

Merge remote-tracking branch 'origin/master' into explorer-name-stand…

35d4d7e

…ardization

ikesau merged commit 0151ad6 into master Feb 16, 2024
16 of 17 checks passed

ikesau deleted the explorer-name-standardization branch February 16, 2024 16:46

ikesau mentioned this pull request Feb 23, 2024

Explorer tagging #2560

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🎉 UI updates for standardized explorer names, explore tagging, and an `explorer-tiles` component #3158

🎉 UI updates for standardized explorer names, explore tagging, and an `explorer-tiles` component #3158

ikesau commented Jan 31, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 31, 2024 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

ikesau commented Feb 13, 2024

ikesau Feb 13, 2024

mlbrgl left a comment

mlbrgl left a comment

mlbrgl Feb 14, 2024

mlbrgl Feb 14, 2024

ikesau Feb 15, 2024

🎉 UI updates for standardized explorer names, explore tagging, and an explorer-tiles component #3158

🎉 UI updates for standardized explorer names, explore tagging, and an explorer-tiles component #3158

Conversation

ikesau commented Jan 31, 2024 • edited by coderabbitai bot Loading

Charts page:

Explorer Tiles component:

Explorer page:

Explorer prominent link:

Summary by CodeRabbit

coderabbitai bot commented Jan 31, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

ikesau commented Feb 13, 2024

ikesau Feb 13, 2024

Choose a reason for hiding this comment

mlbrgl left a comment

Choose a reason for hiding this comment

mlbrgl left a comment

Choose a reason for hiding this comment

mlbrgl Feb 14, 2024

Choose a reason for hiding this comment

mlbrgl Feb 14, 2024

Choose a reason for hiding this comment

ikesau Feb 15, 2024

Choose a reason for hiding this comment

🎉 UI updates for standardized explorer names, explore tagging, and an `explorer-tiles` component #3158

🎉 UI updates for standardized explorer names, explore tagging, and an `explorer-tiles` component #3158

ikesau commented Jan 31, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 31, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)