chore(ui): align user-facing copy & naming with Redis style guide#6112
Open
DimoHG wants to merge 4 commits into
Open
chore(ui): align user-facing copy & naming with Redis style guide#6112DimoHG wants to merge 4 commits into
DimoHG wants to merge 4 commits into
Conversation
Apply the Redis product copy & naming style guide (June 2026): "Redis Query Engine" is the retired name for "Redis Search". Update user-facing copy across module/feature messages, onboarding, the AI assistant, workbench results, the vector-search fallback, the module display-name map, the geodata plugin descriptions, and the redisearch plugin title, plus the tests and e2e references that assert on these strings. Pure display-string changes (the values are typed as `string`, not literal types), so no behavior or type changes. Mock/API-mirroring data, generated files (api-client, openapi.json), the redis-enterprise module, and minified bundles are intentionally left untouched. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Apply the Redis product copy & naming style guide (June 2026) across
user-facing UI strings found in a full audit of redisinsight/ui:
- Database verb is "build", never "create": Cloud-database CTAs, buttons,
notifications, and help text in the OAuth flow, message panels, AI
assistant, nav menu, home, settings, and vector-search fallback.
- Retired product name: "Redis Enterprise Cloud" -> "Redis Cloud" and the
Cloud autodiscover result titles; bare "Query Engine" -> "Redis Search".
- Replace hype CTAs ("Get Started For Free", "Start with Cloud for free",
"Create FREE ...") with functional, sentence-case actions.
- Sentence case for headings, buttons, tabs, table headers, placeholders,
tooltips, and empty states (e.g. stream empty states, pub-sub
placeholders, database-analysis column titles, "Learn more", "Our tips").
- "documentation" -> "docs"; "Document Store with JSON native" ->
"Document store with native JSON".
Names referring to the actual Redis Enterprise / Redis Enterprise Software
product, the Azure "Cache for Redis Enterprise" product, the legal
agreement title, Redis Cloud "subscription" resources, and code
identifiers are intentionally left unchanged. Judgment calls that need
product/PM input (error-message restructuring, plugin module-name
descriptions, standalone data-type labels) are deferred. Specs and e2e
page objects asserting the changed strings are updated to match.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
🛡️ Jit Security Scan Results✅ No security findings were detected in this PR
Security scan by Jit
|
Exhaustive sweep of redisinsight/ui completing the style-guide alignment: sentence case for every heading, button, tab, menu item, label, placeholder, tooltip, aria-label, table header, and empty/error/success message, plus remaining abbreviation fixes (application->app, documentation->docs) and data-type label casing (Sorted set, Vector set, Time series, Bloom filter). Acronyms (ID, IP, URL, TLS, SSH, JSON, TTL, API, DB, CLI, RDI, ...), product/proper nouns (Redis, Redis Insight, Redis Cloud, Redis Search, Sentinel, Azure, Workbench, GitHub), the redis-enterprise product references, Redis Cloud "subscription" resources, legal titles, and telemetry event values (pageViews enums) are all preserved. Feature-name casing was reconciled to be consistent across navigation, page titles, and badges. Spec and e2e page-object assertions were updated to match. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Update three co-located specs whose assertions still referenced the
pre-rename strings (caught by CI frontend-tests):
- InfiniteMessages: "create a free database" -> "build", button /Create/ -> /Build database/
- AzureDatabases: getByText('Access Key') -> 'Access key'
- Recommendation: tutorial button text 'Tutorial' -> 'Start tutorial'
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Contributor
Code Coverage - Frontend unit tests
Test suite run success7294 tests passing in 826 suites. Report generated by 🧪jest coverage report action from 99901d1 |
dantovska
approved these changes
Jun 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Aligns all user-facing copy and naming in
redisinsight/uiwith the Redis product copy & naming style guide (June 2026). Found and applied with theredis-copy-styleaudit skill across pages, components, constants, and plugin packages. 309 files vsmain.Change breakdown
Database Analysis→Database analysisRedis Query Engine→Redis Search,Redis Enterprise Cloud→Redis CloudSorted Set→Sorted set,Vector Set→Vector setcreate→buildCreate a free Redis Cloud database→Build a free…PubSub→Pub/SubDesktop application→Desktop app,documentation→docsGet Started For Free→Build a free database(~a third of line changes are test/e2e assertions mirroring the source strings. Shares are token-level change counts across the diff.)
Deliberately NOT changed
subscriptionresources, telemetry event values (pageViewsenums), and all code identifiers / enum keys / test ids.Deferred (need product/PM judgment)
api/src"Redis Enterprise" API descriptions (the product the app connects to).Verification
eslintclean on all changed UI + e2e files; the 4 pluginpackage.jsonfiles validate.yarn type-check/ jest not runnable locally (Node < 24; plus a pre-existingapiClient/Environmenttest-setup circular import that fails on a clean tree). CI is the gate — watch the first run given the breadth.Status
Draft. Supersedes #6110 (the Redis Query Engine → Redis Search rename, now folded in here). The
create→buildrename and the broad sentence-case sweep are real product-copy decisions worth a copy-owner's review before this leaves draft.🤖 Generated with Claude Code
Note
Low Risk
Display-string and test-assertion updates only; no auth, API, or business-logic changes, though the wide surface area means CI should catch any missed string references in tests.
Overview
Brings redisinsight/ui user-visible text in line with the Redis copy & naming style guide across navigation, browser, analytics, OAuth/cloud flows, autodiscovery, onboarding, notifications, and bundled visualization plugins.
Most edits are sentence case for titles, tabs, tooltips, placeholders, and buttons (e.g.
Database analysis,Slow log,Add key). Product naming shifts retired or inconsistent labels to current terms—notably Redis Query Engine → Redis Search in module messaging, onboarding, workbench copy, and geodata/redisearch plugin descriptions—and Redis Cloud wording where Enterprise Cloud labels appeared. CTAs move from hype-style copy to functional actions (Get Started For Free→Build a free database; OAuth flows useBuild databasewhile underlying create actions are unchanged). Smaller sweeps cover data-type display names (Sorted set,Vector set),Pub/Sub,application→appin a few places, and clearer actions such as Make searchable instead of Continue on one modal.Specs and e2e assertions are updated wherever they query the old strings; identifiers, telemetry enums, and legal/enterprise product names called out in the PR description are intentionally left alone.
Reviewed by Cursor Bugbot for commit 99901d1. Bugbot is set up for automated code reviews on this repo. Configure here.