Skip to content

fix: Make usage of quotes for templating consistent #22605

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

Closed
wants to merge 1 commit into from
Closed

fix: Make usage of quotes for templating consistent #22605

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/operator-manual/applicationset/Generators-Git.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ spec:
source:
repoURL: https://github.com/argoproj/argo-cd.git
targetRevision: HEAD
path: "{{.values.base_dir}}/apps/guestbook"
path: '{{.values.base_dir}}/apps/guestbook'
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
path: '{{.values.base_dir}}/apps/guestbook'
path: '{{.values.base_dir}}/apps/guestbook'

I personally think it isn't necessary. If we change it to single dash, this gives the user a perspective that only single dash could be used (unless they try double dash too). Having both sort of examples makes sense. Although you're correct about consistency around docs but I don't think it's such a big change that needs to be consistent across all docs. Having said that, I'm proposing to revert the changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree that having both examples makes sense. But if I got confused by it, others will, too. It's literally the only place on the whole page where double quotes are used around templated values 😅

Copy link
Member

Choose a reason for hiding this comment

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

Sorry but I'm still not sure if it's required. Instead adding it as a note would make more sense.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, I definitely agree in regards to the note! Would be good to put it somewhere globally? How about in the FAQ ?

Copy link
Member

Choose a reason for hiding this comment

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

Just add it in the docs rather than FAQ.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will do, I'm just very busy this week. But it's on my list!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here is my proposal @nitishfy : #23003

destination:
server: '{{.cluster.address}}'
namespace: guestbook
Expand Down