Red Hat Bugzilla – Bug 1263469
Syntax used in the doc examples
Last modified: 2017-10-22 22:48:14 EDT
Describe the issue:
Example are formatted in YAML and JSON. This proves an issue when you are using the templates as an example to configure an object in your environment.
= Customers understand both can be passed, and that there are converts out there. Just a suggestion for improvement.
Creating a provisioned project template and using this yaml example:
And wanting to add section in it for quota, Limit Ranges etc which have json as the examples.
Suggestions for improvement:
Stay with one type either yaml or json
We've been trying to use YAML in examples for a while, but there's still some older content using JSON. I'll be converting any remaining JSON.