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
Configuration sample in reference doc has wrong yaml formatting #28671
Conversation
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.
Thanks for the PR, I've left a couple comments.
- USER | ||
- ADMIN | ||
service: | ||
remote-address: "192.168.1.1" |
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.
This PR is doing two different things here. Are the quote around the value necessary?
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.
Ha, I think the String type here is more suitable, so I just did it.
service: | ||
remote-address: "192.168.1.1" | ||
security: | ||
username: "admin" |
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.
Ditto
Thanks again @weixsun. I have reverted the quote change as discussed (not necessary and inconsistent with other configuration samples). |
I think we should probably quote Strings in YAML. I tried to add a review note but I didn't click "submit" 🤦. I've opened #28709. |
This pr is just a modification of the code style of the yaml code block.