Skip to content
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

docs: Fix bad cluster generator parameters #17770

Merged
merged 2 commits into from
Jun 28, 2024
Merged

docs: Fix bad cluster generator parameters #17770

merged 2 commits into from
Jun 28, 2024

Conversation

lindhe
Copy link
Contributor

@lindhe lindhe commented Apr 8, 2024

The previous variant used parameters cluster and url, which are nowhere to be found (I'm guessing it's from an old version of the Cluster generator). This change replaces them with the current .nameNormalized and .server parameters.

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 Toolchain Guide
  • 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).

@lindhe
docs: Fix bad cluster generator parameters
c778a87 
The previous variant used parameters `cluster` and `url`, which are
nowhere to be found (I'm guessing it's from an old version of the
Cluster generator). This change replaces them with the current
`.nameNormalized` and `.server` parameters.

Signed-off-by: Andreas Lindhé <andreas@lindhe.io>
@lindhe lindhe requested review from a team as code owners April 8, 2024 06:17
@lindhe
Copy link
Contributor Author

lindhe commented Apr 8, 2024

It would be great if someone with more knowledge about the ApplicationSet templates could read through the docs and try to catch any other irregularities. Then we can include those fixes in the same PR!

@christianh814 christianh814 added the type:docs Missing or incomplete documentation label Jun 26, 2024
@lindhe
docs: Add reference to cluster generator docs
c2c695a 
Signed-off-by: Andreas Lindhé <andreas@lindhe.io>
todaywasawesome
todaywasawesome approved these changes Jun 28, 2024
View reviewed changes
Copy link
Contributor

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

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

Good addition and better default example.

@todaywasawesome todaywasawesome merged commit 0a14ef9 into argoproj:master Jun 28, 2024
23 checks passed
@lindhe lindhe deleted the lindhe/fix-templates-docs branch June 29, 2024 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@todaywasawesome todaywasawesome todaywasawesome approved these changes

@christianh814 christianh814 christianh814 approved these changes

Assignees
No one assigned
Labels
type:docs Missing or incomplete documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@lindhe @todaywasawesome @christianh814