Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1683026

Summary: [DOCS] Suggest "Table 1. Required parameters" parameters use the same format as "Table 2. Optional AWS platform parameters"
Product: OpenShift Container Platform Reporter: Qin Ping <piqin>
Component: DocumentationAssignee: Kathryn Alexander <kalexand>
Status: CLOSED CURRENTRELEASE QA Contact: Qin Ping <piqin>
Severity: medium Docs Contact: Vikram Goyal <vigoyal>
Priority: medium    
Version: 4.1.0CC: aos-bugs, jokerman, mmccomas, wsun
Target Milestone: ---   
Target Release: 4.1.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-02-28 13:55:01 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 Qin Ping 2019-02-26 06:24:31 UTC
Document URL:
https://docs.openshift.com/container-platform/4.0/installing-aws/installing-customizations-cloud.html#installation-aws-config-yaml-install-customizations-cloud

Section Number and Name:
Table 1. Required parameters

Describe the issue:
The parameters in table 1 is not understandable as table 2

Suggestions for improvement:
such as:
provider <-> platform
name <-> metadata.name
...

Additional information

Comment 1 Kathryn Alexander 2019-02-26 21:31:29 UTC
PR's here: https://github.com/openshift/openshift-docs/pull/13831

@Qin Ping, will you PTAL? I updated the parameters to match the new sample YAML that Jianlin Liu pointed out on https://bugzilla.redhat.com/show_bug.cgi?id=1683131.

Comment 2 Qin Ping 2019-02-27 02:09:35 UTC
LGTM

Comment 3 Kathryn Alexander 2019-02-27 16:45:30 UTC
Thanks! I've merged the change and am waiting for it to go live.