Skip to content

Fix plugin name#11

Merged
SuJinpei merged 2 commits intomasterfrom
fix-plugin-name
Sep 25, 2025
Merged

Fix plugin name#11
SuJinpei merged 2 commits intomasterfrom
fix-plugin-name

Conversation

@SuJinpei
Copy link
Copy Markdown
Contributor

@SuJinpei SuJinpei commented Sep 25, 2025

Summary by CodeRabbit

  • Documentation

    • Updated product name references from “Alauda Database Service for MySQL-PXC” to “Alauda Database Service for MySQL” across intro, installation, access, create instance, and upgrade guides.
    • Aligned plugin naming in UI-related instructions without changing procedures or capabilities.
  • Chores

    • Refreshed site branding (title and logo text) to reflect the updated product name.
    • Adjusted site version tag to “fix-plugin-name” for consistency.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Sep 25, 2025

Walkthrough

Renames product references from “Alauda Database Service for MySQL-PXC” to “Alauda Database Service for MySQL” across multiple English docs and configuration files. Updates site config version string to “fix-plugin-name.” No procedural, feature, or control-flow changes.

Changes

Cohort / File(s) Summary
Docs: Product name rename
docs/en/functions/01_create_instance.mdx, docs/en/functions/05_access.mdx, docs/en/functions/17_upgrade.mdx, docs/en/installation.mdx, docs/en/intro.mdx, docs/en/upgrade.mdx
Replace occurrences of “MySQL-PXC” with “MySQL” in headings and prose; content and procedures unchanged.
Site branding config
doom.config.yml
Update title and logoText from “MySQL-PXC” to “MySQL”; no other config changes.
Site version tag
sites.yaml
Change acp site version from 4.0 to fix-plugin-name.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • sinbadonline

Poem

I twitch my ears at labels new,
Hop-hop through docs with freshened hue.
From PXC to plain MySQL,
The titles ring a cleaner bell.
A nibble of change, a branded delight—
Carrot-approved, the pages read right. 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title succinctly captures the pull request’s main objective of renaming the plugin across documentation and configuration, directly reflecting the core change in the changeset without extraneous wording.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-plugin-name

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cc16277 and 16df11d.

📒 Files selected for processing (8)
  • docs/en/functions/01_create_instance.mdx (1 hunks)
  • docs/en/functions/05_access.mdx (1 hunks)
  • docs/en/functions/17_upgrade.mdx (1 hunks)
  • docs/en/installation.mdx (1 hunks)
  • docs/en/intro.mdx (1 hunks)
  • docs/en/upgrade.mdx (1 hunks)
  • doom.config.yml (1 hunks)
  • sites.yaml (1 hunks)
🔇 Additional comments (5)
doom.config.yml (1)

1-2: Brand rename aligns with site metadata.

Title and logo text now match the updated product name; looks good.

docs/en/upgrade.mdx (1)

12-14: Intro text matches the new product name.

The branding update is consistent here.

docs/en/functions/17_upgrade.mdx (1)

6-6: Name update stays consistent.

No further issues spotted in this section.

docs/en/intro.mdx (1)

12-12: Intro reflects the updated branding.

Looks consistent with the rest of the rename.

docs/en/installation.mdx (1)

65-79: Plugin section correctly references the new name.

The procedure now points to “Alauda Database Service for MySQL,” matching the rename.

- name: acp
base: /container_platform
version: "4.0"
version: "fix-plugin-name"
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Restore a valid documentation version identifier

Replacing the version with the branch name ("fix-plugin-name") breaks the expected semantic versioning for this site entry—everything else (e.g., release-notes filters) still targets 4.0, and the docs UI will now surface an odd/non-version string. Please keep this field on the actual release version so navigation and publishing continue to work correctly.

-  version: "fix-plugin-name"
+  version: "4.0"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
version: "fix-plugin-name"
version: "4.0"
🤖 Prompt for AI Agents
In sites.yaml around line 3, the version field was changed to the branch name
("fix-plugin-name"), which breaks semantic versioning and site tooling; restore
the correct release version (e.g., "4.0") in that field so release-notes,
navigation, and publishing continue to work as expected.

@SuJinpei SuJinpei merged commit 1fd4154 into master Sep 25, 2025
2 checks passed
@JounQin JounQin deleted the fix-plugin-name branch October 29, 2025 03:24
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.

1 participant