Bug 884916 - Link wiki deployment guide in the formal guide as interim solution
Summary: Link wiki deployment guide in the formal guide as interim solution
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 1.0.0
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: ---
Assignee: Bilhar
QA Contact: ecs-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-12-07 02:33 UTC by Luke Meyer
Modified: 2015-07-20 00:22 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2012-12-13 23:43:39 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Luke Meyer 2012-12-07 02:33:26 UTC
Description of problem:

We want the content from https://openshift.redhat.com/community/wiki/deployment-guide-to-openshift-on-rhel-6 included in the deployment guide.

In the short term, please link to this until we get the full document update.

It is mostly stuff that's outside the realm of the kickstart, but it's definitely stuff that enterprise users will want to know about. Not sure how to discuss in the doc; something along the lines of "for further information about enterprise deployment that is currently making its way into formal docs, please see this wiki page."

Comment 2 Bilhar 2012-12-10 01:14:09 UTC
We can do this. I'm thinking of creating a link at the beginning of Chapter 3 of the Deployment Guide here: https://url.corp.redhat.com/a4d1a15

Please confirm.

Comment 3 Luke Meyer 2012-12-10 19:03:14 UTC
Looking at it, there's just no one good place to put it... and I do want it to be very visible.

If you only want to keep track of one place, I would say to add a section 3.5 "Beyond the basic installation" linking to the page.

Since it's really intended to be looked at after the basic installation is complete, though, and they're likely to forget by that time, I'm also looking for some way to put it at the end. But it certainly doesn't merit its own chapter. My thought is this: add an extra section to each of the broker and node sections, each linking to the respective part of the wiki. So,

Section 5.8 "Beyond the basic installation" links to https://openshift.redhat.com/community/wiki/deployment-guide-to-openshift-on-rhel-6#Broker_Host_Details_and_Capabilities
Section 6.8 "Beyond the basic installation" links to https://openshift.redhat.com/community/wiki/deployment-guide-to-openshift-on-rhel-6#Node_Host_Details_and_Capabilities

Comment 4 Bilhar 2012-12-11 02:09:20 UTC
I've updated the 1.0 Deployment Guide, and added the new sections with links as suggested. Sections 5.8 and 6.8 have been added.  Details below:

Package Info:
OpenShift_Enterprise-Deployment_Guide-1.0-web-en-US-1.0-9.0.el6eng

Doc can be reviewed here:
https://url.corp.redhat.com/9d6c7d3

Please review and confirm so that it can be published after QE approval.

Comment 5 Luke Meyer 2012-12-11 04:34:22 UTC
I will try not to make a mountain out of a molehill here... I don't want the contents of that wiki page labeled "advanced". It implies that it's optional. Definitely some optional stuff on there but the majority of it is required for implementing selling features. The sole reason it is not in the manual yet is time constraints of the release. 

The "BYO" described features you could set up almost entirely by running a script, to have something to demo. This guide is mainly for those features that by nature are a little more personalized (the exceptions being things that just came late in the process - idler and console).

So anyway. Please, not "Advanced" anything. I would like a link that people will follow to continue their installation. There is a little difference between the broker and node topics - the broker ones are really about customization, while the node ones are mainly about using the features. There's not a lot about installation there, but a lot about configuration. So, let me suggest something along this line:

5.8. Continuing OpenShift Enterprise Broker Configuration
For further points on customizing your broker installation for enterprise use, refer to instructions located on openshift.redhat.com. (N.B.: there is no www.) The linked page is in the process of being incorporated into this Deployment Guide.

6.8. Continuing OpenShift Enterprise Node Configuration
To continue configuration of your node hosts for enterprise use, refer to instructions located on openshift.redhat.com. The linked page is in the process of being incorporated into this Deployment Guide.

Comment 6 Bilhar 2012-12-11 09:50:57 UTC
My bad on the URL. I've implemented the suggestions, and changed the headings. Details of the build are below.

Package Info:
OpenShift_Enterprise-Deployment_Guide-1.0-web-en-US-1.0-9.1.el6eng

Doc can be reviewed here:
http://documentation-devel.engineering.redhat.com/docs/en-US/OpenShift_Enterprise/1.0/html/Deployment_Guide/index.html

Comment 7 xjia 2012-12-12 10:05:15 UTC
Seem all the things look good.
Verify it:

Comment 8 Bilhar 2012-12-13 23:43:39 UTC
This fix has been published to customer portal in the current release of the OSE Deployment Guide.  Below is the link, BZ will be closed.

https://url.corp.redhat.com/030de90


Note You need to log in before you can comment on or make changes to this bug.