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

Bug 1526428

Summary: [DOCS] [RFE] Installation Guide: Reorder bullet list in Section 2.1.1 Initial Planning
Product: OpenShift Container Platform Reporter: Thom Carlin <tcarlin>
Component: DocumentationAssignee: Alex Dellapenta <adellape>
Status: CLOSED CURRENTRELEASE QA Contact: Johnny Liu <jialiu>
Severity: medium Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 3.7.0CC: aos-bugs, jokerman, mmccomas
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard: 3.10-release-plan
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-05-10 20:26:04 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:
Bug Depends On:    
Bug Blocks: 1724792    

Description Thom Carlin 2017-12-15 12:44:34 UTC
Document URL: 

https://access.redhat.com/documentation/en-us/openshift_container_platform/3.7/html-single/installation_and_configuration/#inital-planning

Section Number and Name: 

Section 2.1.1 Initial Planning

Describe the issue: 

Sizing Considerations is listed after Environment Scenarios in the bullet list.  However, Environment Scenarios depends on Sizing Considerations (e.g. https://access.redhat.com/documentation/en-us/openshift_container_platform/3.7/html-single/installation_and_configuration/#environment-scenarios states "Use these scenarios as a basis for planning your own OpenShift Container Platform cluster, based on your sizing needs.")

Further, Section 2.1.3 Sizing Considerations is before Section 2.1.4 Environment Scenarios in the document

Suggestions for improvement: 

Swap bullet items 2 and 3:
"* Which installation method do you want to use? The Installation Methods section provides some information about the quick and advanced installation methods.
* How many pods are required in your cluster? The Sizing Considerations section provides limits for nodes and pods so you can calculate how large your environment needs to be.
* How many hosts do you require in the cluster? The Environment Scenarios section provides multiple examples of Single Master and Multiple Master configurations.
* Is high availability required? High availability is recommended for fault tolerance. In this situation, you might aim to use the Multiple Masters Using Native HA example as a basis for your environment.
* Which installation type do you want to use: RPM or containerized? Both installations provide a working OpenShift Container Platform environment, but you might have a preference for a particular method of installing, managing, and updating your services.
* Is my installation supported if integrating with other technologies? See the OpenShift Container Platform Tested Integrations for a list of tested integrations."

Additional information:

Comment 3 openshift-github-bot 2018-04-02 15:40:54 UTC
Commit pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/2ddd9c1435262e362ce83dd3df8e3636e0518ad0
Merge pull request #8535 from adellape/planning_bullets

Bug 1526428: Flip planning bullets + ifdef openstack on origin content

Comment 4 Alex Dellapenta 2018-04-02 17:42:54 UTC
enterprise-3.7:

https://github.com/openshift/openshift-docs/pull/8543

enterprise-3.9 + enterprise-3.10 (required some other unrelated origin ifdefs):

https://github.com/openshift/openshift-docs/pull/8535
https://github.com/openshift/openshift-docs/pull/8537