-
Notifications
You must be signed in to change notification settings - Fork 2
PCSM-231 Product renaming #23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Kept previous releases with old product name
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR renames the product from "Percona Link for MongoDB" (PLM) to "Percona ClusterSync for MongoDB" (PCSM) throughout the documentation. The renaming preserves the old product name in historical release notes (versions 0.5.0 and 0.6.0) while updating all current documentation and references to use the new branding.
Key changes:
- Updated product naming variables and references from PLM to PCSM across all documentation
- Replaced snippet files to use new product name
- Renamed service-related files and commands (plm → pcsm)
- Updated repository references and URLs
- Preserved old product name in historical release notes (0.5.0 and 0.6.0)
Reviewed changes
Copilot reviewed 37 out of 37 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| variables.yml | Updated product name variables from plm to pcsm |
| snippets/plm-description.md | Removed old product description snippet |
| snippets/pcsm-description.md | Added new product description snippet with updated name |
| mkdocs-base.yml | Updated site name, repository references, and navigation items |
| docs/troubleshooting.md | Replaced all PLM references with PCSM throughout troubleshooting guide |
| docs/system-requirements.md | Updated product name references in system requirements |
| docs/release-notes/0.6.0.md | Preserved old product name for historical 0.6.0 release |
| docs/release-notes/0.5.0.md | Preserved old product name for historical 0.5.0 release |
| docs/release-notes.md | Updated heading while preserving old name in release links |
| docs/reference/glossary.md | Updated product references in glossary definitions |
| docs/reference/contributing.md | Deleted old contributing guidelines file |
| docs/pmm-setup.md | Updated all PLM references to PCSM in monitoring setup guide |
| docs/pcsm-commands.md | Updated command documentation with new product name |
| docs/oplog-sizing.md | Updated product references in oplog sizing guide |
| docs/logging.md | Updated product references in logging documentation |
| docs/limitations.md | Updated product name in limitations documentation |
| docs/intro.md | Updated product references throughout introduction |
| docs/installation.md | Updated product name in quickstart guide |
| docs/install/usage.md | Updated all product references in usage documentation |
| docs/install/start-plm.md | Removed old PLM startup guide |
| docs/install/start-pcsm.md | Added new PCSM startup guide |
| docs/install/source.md | Updated build instructions with new repository and product name |
| docs/install/repos.md | Updated repository installation guide with new product name |
| docs/install/parameters.md | Updated parameter documentation and environment variable names |
| docs/install/authentication.md | Updated authentication guide with new product name |
| docs/index.md | Updated main documentation page with new product name |
| docs/get-help.md | Updated product reference in help page |
| docs/faq.md | Updated all product references in FAQ |
| docs/deployment.md | Expanded deployment documentation with sharding support and restructured content |
| docs/copyright.md | Updated product name in copyright notice |
| docs/compare.md | Updated product name in comparison documentation |
| docs/api.md | Updated product name in API documentation |
| docs/about-docs.md | Updated product references and Jira project link |
| _resource/overrides/partials/banner.html | Updated help link URL |
| _resource/overrides/main.html | Updated product name, URLs, and forum link |
| README.MD | Updated product name and repository references |
| CONTRIBUTING.md | Updated product name and simplified build instructions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| {{pcsm.full_name}} supports the following deployment topologies: | ||
|
|
||
| * **Replica Set to Replica Set**: The source and target replica sets can have different numbers of nodes. | ||
| * **Sharded cluster to Sharded cluster**: The source and target sharded clusters can have different numbers of shards. This functionality is in tech preview stage. See [Sharding support in {{pcsm.full_name}}](sharding.md) for details. |
Copilot
AI
Jan 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link references sharding.md but this file is not included in the PR changes. Either the file needs to be added or the link should be removed/updated to point to an existing resource.
| * **Sharded cluster to Sharded cluster**: The source and target sharded clusters can have different numbers of shards. This functionality is in tech preview stage. See [Sharding support in {{pcsm.full_name}}](sharding.md) for details. | |
| * **Sharded cluster to Sharded cluster**: The source and target sharded clusters can have different numbers of shards. This functionality is in tech preview stage. See the sharding support documentation for {{pcsm.full_name}} for details. |
| - compare.md | ||
| - deployment.md | ||
| - limitations.md | ||
| - sharding.md |
Copilot
AI
Jan 7, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The navigation includes sharding.md but this file is not present in the PR changes. This will result in a broken navigation link unless the file exists elsewhere or is added.
| - sharding.md |
_resource/overrides/main.html
Outdated
|
|
||
| {% block announce %} | ||
| <p> The version 0.6.0 of Percona Link for MongoDB is the technical preview. We encourage you to test Percona Link for MongoDB and <a href= "https://forums.percona.com/c/mongodb/mongodb-general-discussion/33">give your feedback</a>. | ||
| <p> The version 0.6.0 of Percona ClusterSync for MongoDB is the technical preview. We encourage you to test Percona ClusterSync for MongoDB and <a href= "https://forums.percona.com/c/mongodb/24">give your feedback</a>. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| <p> The version 0.6.0 of Percona ClusterSync for MongoDB is the technical preview. We encourage you to test Percona ClusterSync for MongoDB and <a href= "https://forums.percona.com/c/mongodb/24">give your feedback</a>. | |
| <p> The version 0.6.0 of Percona ClusterSync for MongoDB is the technical preview. We encourage you to test Percona ClusterSync for MongoDB and <a href= "https://forums.percona.com/c/mongodb/percona-link-for-mongodb-plm/87">give your feedback</a>. |
_resource/overrides/main.html
Outdated
| {# Commenting out Download PDF button | ||
| <label class="md-nav__title" for="__drawer"> | ||
| <a href="https://learn.percona.com/download-percona-backup-for-mongodb-manual-2" onclick="_gaq.push(['b._trackEvent', 'Percona Link for MongoDB', 'Download', 'Download Manual Link for MongoDB']);" class="md-nav__link md-nav__link--active" style="font-size: .7rem;"> | ||
| <a href="https://learn.percona.com/download-percona-clustersync-for-mongodb-manual-2" onclick="_gaq.push(['b._trackEvent', 'Percona ClusterSync for MongoDB', 'Download', 'Download Manual ClusterSync for MongoDB']);" class="md-nav__link md-nav__link--active" style="font-size: .7rem;"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that doesn't exist.. is that needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not visible in the docs so let's keep it in case we decide we need PDFs.
| plm: | ||
| full_name: 'Percona Link for MongoDB' | ||
| short: 'PLM' | ||
| pcsm: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it'be best to have this variable name independent from the actual name like "product:"
otherwise this doesn't help when you need to change it everywhere :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
True. Hopefully this is the last renaming:)
docs/release-notes/0.5.0.md
Outdated
| ## Join us in shaping the future of Percona ClusterSync for MongoDB! | ||
|
|
||
| This MVP release is just the beginning. Your real-world experience and feedback are invaluable as we evolve Percona Link for MongoDB. We encourage you to explore {{ plm.short }} for your non-production migration scenarios and share your insights: | ||
| This MVP release is just the beginning. Your real-world experience and feedback are invaluable as we evolve Percona ClusterSync for MongoDB. We encourage you to explore PLM for your non-production migration scenarios and share your insights: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to be consistent with naming here. I'd suggest to leave PLM here as well.
| @@ -1,5 +1,5 @@ | |||
| # {{plm.full_name}} release notes | |||
| # {{pcsm.full_name}} release notes | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add somewhere at this page something like:
Note: As of Version 0.7.0, Percona Link for MongoDB has been rebranded to Percona ClusterSync. All references to Percona Link for MongoDB in previous release notes refer to this product.
1cf5326 to
92aec6a
Compare
Kept previous releases with old product name