Skip to content

NO-JIRA: Capitalize "Basic" in secret dropdown label#16490

Open
sowmya-sl wants to merge 1 commit into
openshift:mainfrom
sowmya-sl:docs-helm-install-with-secrets
Open

NO-JIRA: Capitalize "Basic" in secret dropdown label#16490
sowmya-sl wants to merge 1 commit into
openshift:mainfrom
sowmya-sl:docs-helm-install-with-secrets

Conversation

@sowmya-sl
Copy link
Copy Markdown
Contributor

@sowmya-sl sowmya-sl commented May 25, 2026

Align with content guidelines that capitalize protocol names in UI labels ("Basic authentication" instead of "basic authentication").

Summary by CodeRabbit

  • Style
    • Standardized the capitalization of Basic authentication labels throughout Helm plugin forms. Updated secret dropdown label text and corresponding translation strings to consistently use proper title case formatting, resulting in improved visual consistency and a more polished, professional appearance across the user interface.

Align with content guidelines that capitalize protocol names in UI
labels ("Basic authentication" instead of "basic authentication").
@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label May 25, 2026
@openshift-ci-robot
Copy link
Copy Markdown
Contributor

@sowmya-sl: This pull request explicitly references no jira issue.

Details

In response to this:

Align with content guidelines that capitalize protocol names in UI labels ("Basic authentication" instead of "basic authentication").

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot requested review from martinszuc and webbnh May 25, 2026 08:37
@openshift-ci openshift-ci Bot added component/helm Related to helm-plugin kind/i18n Indicates issue or PR relates to internationalization or has content that needs to be translated approved Indicates a PR has been approved by an approver from all required OWNERS files. labels May 25, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 5dcb46cc-18e3-4f92-8838-ae2dbf4aecc9

📥 Commits

Reviewing files that changed from the base of the PR and between e466d37 and ac5d5c3.

📒 Files selected for processing (3)
  • frontend/packages/helm-plugin/locales/en/helm-plugin.json
  • frontend/packages/helm-plugin/src/components/forms/url-chart/HelmURLChartForm.tsx
  • frontend/packages/helm-plugin/src/components/forms/url-chart/HelmURLInstallForm.tsx

Walkthrough

The pull request updates the capitalization of "Basic authentication" to "Basic Authentication" in the Helm plugin's UI labels and translations. The i18n translation key is updated, and two component forms that reference it are synchronized to use the capitalized form consistently.

Changes

Basic authentication label capitalization

Layer / File(s) Summary
Translation key and component label capitalization
frontend/packages/helm-plugin/locales/en/helm-plugin.json, frontend/packages/helm-plugin/src/components/forms/url-chart/HelmURLChartForm.tsx, frontend/packages/helm-plugin/src/components/forms/url-chart/HelmURLInstallForm.tsx
The i18n translation entry for the basic-auth secret label is updated to capitalize "Basic authentication". Both HelmURLChartForm and HelmURLInstallForm component dropdown labels are updated to reference the new capitalized translation key.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 11 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is minimal and lacks required template sections like Analysis, Solution details, Test cases, Browser conformance, and Reviewer information. Expand the description to follow the required template structure, including Analysis/Root cause, Solution description details, Test cases, Browser conformance checkboxes, and appropriate reviewer tags.
✅ Passed checks (11 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: capitalizing 'Basic' in the secret dropdown label text.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Stable And Deterministic Test Names ✅ Passed PR contains only frontend UI/localization changes with no Ginkgo test files or test declarations, making the Ginkgo test naming check not applicable.
Test Structure And Quality ✅ Passed PR contains only frontend UI/i18n changes with no Ginkgo test code. Ginkgo is a Go testing framework; this project uses JavaScript/TypeScript frameworks.
Microshift Test Compatibility ✅ Passed PR contains only frontend UI changes (TypeScript/React components and i18n JSON) with no new Ginkgo e2e tests, making the MicroShift test compatibility check not applicable.
Single Node Openshift (Sno) Test Compatibility ✅ Passed This PR contains only frontend UI and i18n changes (Helm plugin components and localization files). No Ginkgo e2e tests are added, making the SNO compatibility check not applicable.
Topology-Aware Scheduling Compatibility ✅ Passed PR contains only frontend UI/i18n text changes (capitalization); no deployment manifests, operator code, or scheduling constraints are introduced.
Ote Binary Stdout Contract ✅ Passed PR contains only frontend UI and i18n changes to TypeScript/React components; no Go code, test infrastructure, or process-level stdout writes.
Ipv6 And Disconnected Network Test Compatibility ✅ Passed PR contains no Ginkgo e2e tests—only frontend UI components and i18n configuration files with text capitalization changes. Check is not applicable.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 25, 2026

@sowmya-sl: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-gcp-console ac5d5c3 link true /test e2e-gcp-console

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Copy link
Copy Markdown
Contributor

@martinszuc martinszuc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@logonoff
Copy link
Copy Markdown
Member

@coderabbitai perform the microcopy-review skill without ibm context

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Look at the full HelmURLChartForm to understand surrounding microcopy
cat frontend/packages/helm-plugin/src/components/forms/url-chart/HelmURLChartForm.tsx

echo "---"

cat frontend/packages/helm-plugin/src/components/forms/url-chart/HelmURLInstallForm.tsx

echo "---"

# Check the locale file for surrounding strings
cat frontend/packages/helm-plugin/locales/en/helm-plugin.json | python3 -c "
import json, sys
data = json.load(sys.stdin)
# Print keys/values that contain 'auth' or 'secret' or 'Basic' or 'basic' or 'credential'
for k, v in data.items():
    if any(x in k.lower() or x in v.lower() for x in ['auth', 'secret', 'basic', 'credential', 'token', 'tls', 'cert']):
        print(f'{k!r}: {v!r}')
"

echo "---"

# Check for similar patterns in other form components (any auth-related labels)
rg -n --type tsx --type ts -i 'authentication|auth.*secret|secret.*auth' frontend/packages/helm-plugin/src/ 2>/dev/null || \
rg -n -i 'authentication|auth.*secret|secret.*auth' frontend/packages/helm-plugin/src/

Length of output: 18186



@logonoff Here is the microcopy review for this PR, applying general UX writing best practices (Microsoft Writing Style Guide, PatternFly content guidelines, Google developer style):


Microcopy Review — PR #16490

✅ The core change is correct

"Basic" in this context refers to the HTTP Basic Authentication scheme — a proper protocol name. Per mainstream style guides (Microsoft WSG, Google developer style), protocol/scheme names such as "Basic", "OAuth", "TLS" should be capitalized. The change is also internally consistent: the existing locale strings 'Basic authentication' and 'Basic authentication requires HTTPS' already capitalize "Basic", so this PR closes a gap.


🔍 Observations on surrounding microcopy (pre-existing, out of scope for this PR)

Location Current text Suggestion Rationale
Help text (both forms) A secret with "username" and "password" keys for OCI/HTTP(S) authentication Add a trailing period: …OCI/HTTP(S) authentication. All sibling help texts in the same form end with a period ("Unique name for Helm release.", "The version of chart to install.") — inconsistency.
Label (both forms) Secret for Basic authentication Consider Basic authentication secret Noun-first labeling ("protocol + noun") is more natural in English UI labels and matches the shorter sibling labels ("Chart URL", "Release name"). Both forms are grammatically correct; this is a style preference.

Summary

Item Assessment
basic authenticationBasic authentication ✅ Correct — "Basic" is a protocol name
i18n locale key updated to match ✅ Correct
Both form files updated consistently ✅ Correct
Aligns with existing locale entries ✅ Consistent

The change is well-scoped and accurate. The only minor pre-existing inconsistency worth tracking (if desired) is the missing period on the help text for that dropdown field.

Copy link
Copy Markdown
Member

@logonoff logonoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@logonoff
Copy link
Copy Markdown
Member

/label px-approved
/label docs-approved

@openshift-ci openshift-ci Bot added lgtm Indicates that a PR is ready to be merged. px-approved Signifies that Product Support has signed off on this PR docs-approved Signifies that Docs has signed off on this PR labels May 26, 2026
@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci Bot commented May 26, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: logonoff, martinszuc, sowmya-sl

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. component/helm Related to helm-plugin docs-approved Signifies that Docs has signed off on this PR jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. kind/i18n Indicates issue or PR relates to internationalization or has content that needs to be translated lgtm Indicates that a PR is ready to be merged. px-approved Signifies that Product Support has signed off on this PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants