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

Consistently use quotes in YAML samples #28709

Closed
philwebb opened this issue Nov 16, 2021 · 5 comments
Closed

Consistently use quotes in YAML samples #28709

philwebb opened this issue Nov 16, 2021 · 5 comments
Labels
status: superseded An issue that has been superseded by another type: documentation A documentation update

Comments

@philwebb
Copy link
Member

As raised in #28671 we have some YAML in the docs that doesn't quote strings. I think most of the samples do so we should probably align. Using quotes helps prevent the "norway" problem.

@viktorardelean
Copy link
Contributor

Can I work on this issue?
As a first time contributor I think this would be a good start!

@viktorardelean
Copy link
Contributor

Here are all the YAML files that I found on the 2.6.x branch:

  • spring-boot\spring-boot-project\spring-boot-actuator\src\test\resources\db\changelog\db.changelog-master-backup.yaml

  • spring-boot\spring-boot-project\spring-boot-actuator\src\test\resources\db\changelog\db.changelog-master.yaml

  • spring-boot\spring-boot-project\spring-boot-actuator-autoconfigure\src\test\resources\db\changelog\db.changelog-master.yaml

  • spring-boot\spring-boot-project\spring-boot-autoconfigure\src\test\resources\hazelcast.yaml

  • spring-boot\spring-boot-project\spring-boot-autoconfigure\src\test\resources\db\changelog\db.changelog-city.yaml

  • spring-boot\spring-boot-project\spring-boot-autoconfigure\src\test\resources\db\changelog\db.changelog-master.yaml

  • spring-boot\spring-boot-project\spring-boot-autoconfigure\src\test\resources\org\springframework\boot\autoconfigure\hazelcast\hazelcast-client-specific.yaml

  • spring-boot\spring-boot-project\spring-boot-autoconfigure\src\test\resources\org\springframework\boot\autoconfigure\hazelcast\hazelcast-specific.yaml

  • spring-boot\spring-boot-project\spring-boot-devtools\src\test\resources\org\springframework\boot\devtools\env\spring-devtools.yaml

  • spring-boot\spring-boot-tests\spring-boot-smoke-tests\spring-boot-smoke-test-data-r2dbc-liquibase\src\main\resources\db\changelog\db.changelog-master.yaml

  • spring-boot\spring-boot-tests\spring-boot-smoke-tests\spring-boot-smoke-test-liquibase\src\main\resources\db\changelog\db.changelog-master.yaml

Would adding quotes to all the spring values in those YAML files resolve this issue?

@wilkinsona
Copy link
Member

wilkinsona commented Dec 5, 2021

@viktorardelean The aim of this issue is to consistently use quotes in the YAML examples in the documentation. They can be found in the various .adoc files within spring-boot-project/spring-boot-docs/src/docs/asciidoc. Searching for source,yaml within the .adoc files should be a reliable way of identifying each piece of example YAML configuration. If you are interested in contributing the necessary changes, please use 2.6.x as the base branch.

@viktorardelean
Copy link
Contributor

@wilkinsona Thank you very much for the valuable information.
I have raised my PR: #28911

@snicoll
Copy link
Member

snicoll commented Dec 9, 2021

Closing in favor of PR #28911

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: superseded An issue that has been superseded by another type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

4 participants