Skip to content

chore(ui): align user-facing copy & naming with Redis style guide#6112

Open
DimoHG wants to merge 4 commits into
mainfrom
chore/ui-copy-style-compliance
Open

chore(ui): align user-facing copy & naming with Redis style guide#6112
DimoHG wants to merge 4 commits into
mainfrom
chore/ui-copy-style-compliance

Conversation

@DimoHG

@DimoHG DimoHG commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

What

Aligns all user-facing copy and naming in redisinsight/ui with the Redis product copy & naming style guide (June 2026). Found and applied with the redis-copy-style audit skill across pages, components, constants, and plugin packages. 309 files vs main.

Change breakdown

Change type Share Example
Sentence case (Title Case → lowercase) ~76% Database AnalysisDatabase analysis
Retired product names → current ~8% Redis Query EngineRedis Search, Redis Enterprise CloudRedis Cloud
Data-type casing ~7% Sorted SetSorted set, Vector SetVector set
Database verb createbuild ~4% Create a free Redis Cloud databaseBuild a free…
Other / wording ~3% PubSubPub/Sub
Abbreviations ~1% Desktop applicationDesktop app, documentationdocs
Hype CTAs → functional actions ~1% Get Started For FreeBuild 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

  • The actual Redis Enterprise / Redis Enterprise Software product references (cluster autodiscovery), the Azure "Cache for Redis Enterprise" product name, and the legal agreement title.
  • Redis Cloud subscription resources, telemetry event values (pageViews enums), and all code identifiers / enum keys / test ids.
  • Historical module identifiers kept where they are technical (acronyms preserved: ID, IP, URL, TLS, JSON, TTL, API, DB, CLI, RDI…).

Deferred (need product/PM judgment)

  • Error-message restructuring (what happened → why → next) where it needs real failure-reason data.
  • api/src "Redis Enterprise" API descriptions (the product the app connects to).

Verification

  • eslint clean on all changed UI + e2e files; the 4 plugin package.json files validate.
  • Diff-scanned for mangled acronyms / lowercased proper nouns — clean. Cross-area feature-name casing reconciled (nav vs page title vs badges). Spec + e2e page-object assertions updated to match; 0 stranded old references.
  • Pure display-string changes — no type impact. yarn type-check / jest not runnable locally (Node < 24; plus a pre-existing apiClient/Environment test-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 createbuild rename 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 FreeBuild a free database; OAuth flows use Build database while underlying create actions are unchanged). Smaller sweeps cover data-type display names (Sorted set, Vector set), Pub/Sub, applicationapp in 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.

DimoHG and others added 2 commits June 24, 2026 17:32
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-ci

jit-ci Bot commented Jun 25, 2026

Copy link
Copy Markdown

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ 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>
@DimoHG DimoHG changed the title chore(ui): align user-facing copy with Redis style guide chore(ui): align user-facing copy & naming with Redis style guide Jun 25, 2026
@DimoHG DimoHG changed the base branch from chore/rename-redis-query-engine-to-redis-search to main June 25, 2026 08:07
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>
@github-actions

Copy link
Copy Markdown
Contributor

Code Coverage - Frontend unit tests

St.
Category Percentage Covered / Total
🟢 Statements 83.35% 25748/30893
🟡 Branches 68.67% 10854/15805
🟡 Functions 78.56% 6923/8812
🟢 Lines 83.81% 25122/29974

Test suite run success

7294 tests passing in 826 suites.

Report generated by 🧪jest coverage report action from 99901d1

@DimoHG DimoHG marked this pull request as ready for review June 25, 2026 10:53
@DimoHG DimoHG requested a review from a team as a code owner June 25, 2026 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants