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.

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

Closed
wants to merge 1 commit into from

Conversation

weixsun
Copy link
Contributor

@weixsun weixsun commented Nov 14, 2021

This pr is just a modification of the code style of the yaml code block.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Nov 14, 2021
Copy link
Member

@snicoll snicoll left a 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"
Copy link
Member

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?

Copy link
Contributor Author

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"
Copy link
Member

Choose a reason for hiding this comment

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

Ditto

@snicoll snicoll added the status: waiting-for-feedback We need additional information before we can continue label Nov 14, 2021
@snicoll snicoll changed the title Yaml configuration block condensed with 2 spaces Fix yaml sample format Nov 16, 2021
@snicoll snicoll added type: documentation A documentation update and removed status: waiting-for-feedback We need additional information before we can continue status: waiting-for-triage An issue we've not yet triaged labels Nov 16, 2021
@snicoll snicoll self-assigned this Nov 16, 2021
@snicoll snicoll added this to the 2.5.7 milestone Nov 16, 2021
@snicoll snicoll changed the title Fix yaml sample format Configuration sample in reference doc has wrong yaml formatting Nov 16, 2021
snicoll pushed a commit that referenced this pull request Nov 16, 2021
snicoll added a commit that referenced this pull request Nov 16, 2021
@snicoll snicoll closed this in 48ebd1b Nov 16, 2021
@snicoll
Copy link
Member

snicoll commented Nov 16, 2021

Thanks again @weixsun. I have reverted the quote change as discussed (not necessary and inconsistent with other configuration samples).

@philwebb
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants