Skip to content

docs: fixing typo in Config Management Plugins docs #26150

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.

Sign up for GitHub

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

Jump to bottom
Open
aidan-ogorman-dev wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: fixing typo in Config Management Plugins docs #26150

aidan-ogorman-dev wants to merge 1 commit into from
+1 −1

Conversation

@aidan-ogorman-dev
Copy link

@aidan-ogorman-dev aidan-ogorman-dev commented Jan 26, 2026 •
edited
Loading

Fixing a typo in the documentation for Config Management Plugins.

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Title of the PR
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

@aidan-ogorman-dev aidan-ogorman-dev requested review from a team as code owners January 26, 2026 14:17
@bunnyshell
Copy link

bunnyshell bot commented Jan 26, 2026 •
edited
Loading

✅ Preview Environment deployed on Bunnyshell

Component Endpoints
argocd https://argocd-vfsv4n.bunnyenv.com/
argocd-ttyd https://argocd-web-cli-vfsv4n.bunnyenv.com/

See: Environment Details | Pipeline Logs

Available commands (reply to this comment):

  • 🔴 /bns:stop to stop the environment
  • 🚀 /bns:deploy to redeploy the environment
  • ❌ /bns:delete to remove the environment

@aidan-ogorman-dev aidan-ogorman-dev force-pushed the docs/typoConfigManagementPlugins branch from b8b7de5 to 598b999 Compare January 26, 2026 14:21
@aidan-ogorman-dev aidan-ogorman-dev changed the title docs:fixing typo in Config Management Plugins docs docs: fixing typo in Config Management Plugins docs Jan 26, 2026
ppapapetrou76
ppapapetrou76 approved these changes Jan 26, 2026
View reviewed changes
Copy link
Contributor

@ppapapetrou76 ppapapetrou76 left a comment

Choose a reason for hiding this comment

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

LGTM

rumstead
rumstead reviewed Jan 26, 2026
View reviewed changes
docs/operator-manual/config-management-plugins.md
You may leave the `name` field
empty in the `plugin` section for the plugin to be automatically matched with the Application based on its discovery rules. If you do mention the name make sure
it is either `<metadata.name>-<spec.version>` if version is mentioned in the `ConfigManagementPlugin` spec or else just `<metadata.name>`. When name is explicitly
specified only that particular plugin will be used iff its discovery pattern/command matches the provided application repo.
Copy link
Member

@rumstead rumstead Jan 26, 2026

Choose a reason for hiding this comment

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

generally iff stands for "if and only if", are we sure this is a typo?

Copy link
Contributor

@ppapapetrou76 ppapapetrou76 Jan 26, 2026

Choose a reason for hiding this comment

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

@rumstead, in an OSS project, IMHO, documentation such as acronyms should be avoided. Not everyone is a native English speaker, and the assumption that everyone knows the acronyms might be false.

So, overall, we should use if or if and only if

Copy link
Contributor

@olivergondza olivergondza Jan 28, 2026

Choose a reason for hiding this comment

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

It is really a nerd slang, so I would not mind that in OSS project, but yeah, it is worth making the docs easier to grasp for wide audience.

Honestly, I find the sentence quite confusing either way. How about:

When plugin name is explicitly specified, it will be used only if its discovery criteria matches the provided application repo.

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

Reviewers

@rumstead rumstead rumstead left review comments

+4 more reviewers

@olivergondza olivergondza olivergondza left review comments

@ppapapetrou76 ppapapetrou76 ppapapetrou76 approved these changes

@chansuke chansuke chansuke approved these changes

@Kevinjoeharris Kevinjoeharris Kevinjoeharris approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@aidan-ogorman-dev @olivergondza @chansuke @ppapapetrou76 @rumstead @Kevinjoeharris