Bug 1389070

Summary: Update the CNS 3.4 guide with OSP 3.4 links
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Raghavendra Talur <rtalur>
Component: doc-Container_Native_Storage_with_OpenShiftAssignee: Divya <divya>
Status: CLOSED CURRENTRELEASE QA Contact: Prasanth <pprakash>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: cns-3.4CC: asriram, divya, pprakash, rcyriac, rhs-bugs, storage-doc, vigoyal
Target Milestone: ---Flags: divya: needinfo-
Target Release: CNS 3.4   
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: 2017-01-23 07:21:44 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: 1385254    

Description Raghavendra Talur 2016-10-26 19:01:07 UTC 
Description of problem:
In chapter 1, link under bullet point "Dedicated Storage Cluster" is broken. The chapter it should be pointing to is probably moved from 15 to 20.

Version-Release number of selected component (if applicable):
https://access.redhat.com/webassets/avalon/d/Red_Hat_Gluster_Storage-3.1-Container-Native_Storage_for_OpenShift_Container_Platform-en-US/Red_Hat_Gluster_Storage-3.1-Container-Native_Storage_for_OpenShift_Container_Platform-en-US.pdf


How reproducible:
Always
Comment 2 Divya 2016-11-16 06:51:23 UTC 
Updated the link in the Introduction chapter. 

Link to the Introduction chapter: https://doc-stage.usersys.redhat.com/documentation/en/red-hat-gluster-storage/3.1/single/container-native-storage-for-openshift-container-platform/#chap-Documentation-Red_Hat_Gluster_Storage_Container_Native_with_OpenShift_Platform-Introduction_Containerized_RHGS
Comment 5 Prasanth 2017-01-09 13:01:34 UTC 
(In reply to Divya from comment #2)
> Updated the link in the Introduction chapter. 
> 
> Link to the Introduction chapter:
> https://doc-stage.usersys.redhat.com/documentation/en/red-hat-gluster-
> storage/3.1/single/container-native-storage-for-openshift-container-platform/
> #chap-Documentation-
> Red_Hat_Gluster_Storage_Container_Native_with_OpenShift_Platform-
> Introduction_Containerized_RHGS

Why the link to the introduction chapter is pointing to "access.qa.redhat.com" [1] instead of "access.redhat.com" [2]?

Also, ideally it should point to the OCP 3.4 doc (once it is available) instead of OCP 3.3, right?

Divya, can you check the above 2 points and confirm the same from your end?

[1] https://access.qa.redhat.com/documentation/en/openshift-container-platform/3.3/paged/installation-and-configuration/chapter-19-configuring-persistent-storage#install-config-persistent-storage-persistent-storage-glusterfs


[2] https://access.redhat.com/documentation/en/openshift-container-platform/3.3/paged/installation-and-configuration/chapter-20-configuring-persistent-storage#install-config-persistent-storage-persistent-storage-glusterfs
Comment 15 Divya 2017-01-18 10:39:22 UTC 
Updated the CNS 3.4 guide with OSP 3.4 links.

Link to the guide: http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.4-Container_Native_Storage_with_OpenShift_Platform-branch-master/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html
Comment 16 Vikram Goyal 2017-01-18 11:25:57 UTC 
Hey Divya,

ONe correction:

The link for the Persistent Storage for GlusterFS for 3.4 is:
https://access.redhat.com/documentation/en/openshift-container-platform/3.4/single/installation-and-configuration/#install-config-persistent-storage-persistent-storage-glusterfs

Otherwise the rest of the links are correct.
Comment 17 Vikram Goyal 2017-01-18 12:11:37 UTC 
(In reply to Divya from comment #15)
> Updated the CNS 3.4 guide with OSP 3.4 links.
> 
> Link to the guide:
> http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-
> Red_Hat_Gluster_Storage-3.4-Container_Native_Storage_with_OpenShift_Platform-
> branch-master/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html

This page contains the correct updated link. Thanks.
Comment 18 Prasanth 2017-01-18 12:38:26 UTC 
(In reply to Divya from comment #15)
> Updated the CNS 3.4 guide with OSP 3.4 links.
> 
> Link to the guide:
> http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-
> Red_Hat_Gluster_Storage-3.4-Container_Native_Storage_with_OpenShift_Platform-
> branch-master/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html


* In the above doc, I could see in 3 places, which are mentioned below, that the links are still pointing to 'paged'. I believe it should be changed to 'single'? 

Divya, can you check the same and correct it, if required?


######
* For information on creating OpenShift Container Platform cluster with persistent storage using Red Hat Gluster Storage, see https://access.redhat.com/documentation/en/openshift-container-platform/3.4/paged/installation-and-configuration/chapter-21-configuring-persistent-storage#install-config-persistent-storage-persistent-storage-glusterfs



* 3.2.3. Red Hat OpenShift Container Platform Requirements
The following list provides the Red Hat OpenShift Container Platform requirements:
    The OpenShift cluster must be up and running. For information on setting up OpenShift cluster, see https://access.redhat.com/documentation/en/openshift-container-platform/3.4/paged/installation-and-configuration. 



* For more information regarding router setup, see https://access.redhat.com/documentation/en/openshift-container-platform/3.4/paged/installation-and-configuration/chapter-4-setting-up-a-router
######
Comment 19 Divya 2017-01-18 12:47:34 UTC 
(In reply to Prasanth from comment #18)
> (In reply to Divya from comment #15)
> > Updated the CNS 3.4 guide with OSP 3.4 links.
> > 
> > Link to the guide:
> > http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-
> > Red_Hat_Gluster_Storage-3.4-Container_Native_Storage_with_OpenShift_Platform-
> > branch-master/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html
> 
> 
> * In the above doc, I could see in 3 places, which are mentioned below, that
> the links are still pointing to 'paged'. I believe it should be changed to
> 'single'? 
> 
> Divya, can you check the same and correct it, if required?
> 
> 
> ######
> * For information on creating OpenShift Container Platform cluster with
> persistent storage using Red Hat Gluster Storage, see
> https://access.redhat.com/documentation/en/openshift-container-platform/3.4/
> paged/installation-and-configuration/chapter-21-configuring-persistent-
> storage#install-config-persistent-storage-persistent-storage-glusterfs
> 
> 
> 
> * 3.2.3. Red Hat OpenShift Container Platform Requirements
> The following list provides the Red Hat OpenShift Container Platform
> requirements:
>     The OpenShift cluster must be up and running. For information on setting
> up OpenShift cluster, see
> https://access.redhat.com/documentation/en/openshift-container-platform/3.4/
> paged/installation-and-configuration. 
> 
> 
> 
> * For more information regarding router setup, see
> https://access.redhat.com/documentation/en/openshift-container-platform/3.4/
> paged/installation-and-configuration/chapter-4-setting-up-a-router
> ######

Prasanth,

There is no issue if the links are pointed to paged documentation. If the reference is for a chapter or Heading 1, it can added in the Paged (recommended) format. Otherwise, we use "single".

Hope this helps.
Comment 20 Prasanth 2017-01-18 12:57:11 UTC 
(In reply to Divya from comment #19)
> (In reply to Prasanth from comment #18)
> > (In reply to Divya from comment #15)
> > > Updated the CNS 3.4 guide with OSP 3.4 links.
> > > 
> > > Link to the guide:
> > > http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-
> > > Red_Hat_Gluster_Storage-3.4-Container_Native_Storage_with_OpenShift_Platform-
> > > branch-master/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html
> > 
> > 
> > * In the above doc, I could see in 3 places, which are mentioned below, that
> > the links are still pointing to 'paged'. I believe it should be changed to
> > 'single'? 
> > 
> > Divya, can you check the same and correct it, if required?
> > 
> > 
> > ######
> > * For information on creating OpenShift Container Platform cluster with
> > persistent storage using Red Hat Gluster Storage, see
> > https://access.redhat.com/documentation/en/openshift-container-platform/3.4/
> > paged/installation-and-configuration/chapter-21-configuring-persistent-
> > storage#install-config-persistent-storage-persistent-storage-glusterfs
> > 
> > 
> > 
> > * 3.2.3. Red Hat OpenShift Container Platform Requirements
> > The following list provides the Red Hat OpenShift Container Platform
> > requirements:
> >     The OpenShift cluster must be up and running. For information on setting
> > up OpenShift cluster, see
> > https://access.redhat.com/documentation/en/openshift-container-platform/3.4/
> > paged/installation-and-configuration. 
> > 
> > 
> > 
> > * For more information regarding router setup, see
> > https://access.redhat.com/documentation/en/openshift-container-platform/3.4/
> > paged/installation-and-configuration/chapter-4-setting-up-a-router
> > ######
> 
> Prasanth,
> 
> There is no issue if the links are pointed to paged documentation. If the
> reference is for a chapter or Heading 1, it can added in the Paged
> (recommended) format. Otherwise, we use "single".
> 
> Hope this helps.

Ok, thanks for the clarification Divya.

Apart from that, looks like all the links in the CNS 3.4 guide are now pointing to it's respective OCP 3.4 links.