Bug 1263469

Summary: Syntax used in the doc examples
Product: OpenShift Container Platform Reporter: Ryan Howe <rhowe>
Component: DocumentationAssignee: Alex Dellapenta <adellape>
Status: CLOSED CURRENTRELEASE QA Contact: Vikram Goyal <vigoyal>
Severity: high Docs Contact: Vikram Goyal <vigoyal>
Priority: low    
Version: 3.0.0CC: aos-bugs, jokerman, mmccomas
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2017-10-23 02:48:14 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Ryan Howe 2015-09-15 21:16:55 UTC 
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.  

For example 

Creating a provisioned project template and using this yaml example:
https://docs.openshift.com/enterprise/3.0/admin_guide/selfprovisioned_projects.html

And wanting to add section in it for quota, Limit Ranges etc which have json as the examples. 

https://docs.openshift.com/enterprise/3.0/dev_guide/limits.html
https://docs.openshift.com/enterprise/3.0/dev_guide/quota.html

Suggestions for improvement:

Stay with one type either yaml or json  

Additional information: 

some examples

YAML 
https://docs.openshift.com/enterprise/3.0/admin_guide/master_node_configuration.html
https://docs.openshift.com/enterprise/3.0/architecture/additional_concepts/storage.html
https://docs.openshift.com/enterprise/3.0/admin_guide/selfprovisioned_projects.html


JSON 
https://docs.openshift.com/enterprise/3.0/admin_guide/scheduler.html
https://docs.openshift.com/enterprise/3.0/dev_guide/persistent_volumes.html#requesting-storage
https://docs.openshift.com/enterprise/3.0/dev_guide/limits.html
https://docs.openshift.com/enterprise/3.0/architecture/additional_concepts/authentication.html
Comment 3 Alex Dellapenta 2015-09-25 21:56:53 UTC 
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.