Bug 1303266 - [DOCS] [3.2] Enhancements for AEP Guides
Summary: [DOCS] [3.2] Enhancements for AEP Guides
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.1.0
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ---
: ---
Assignee: Zac Dover
QA Contact: Bilhar
Vikram Goyal
URL:
Whiteboard:
: 1272324 1277797 1277802 1277803 1277804 1277806 1277807 1277808 1277810 1277811 (view as bug list)
Depends On:
Blocks: 1272324
TreeView+ depends on / blocked
 
Reported: 2016-01-30 02:05 UTC by Vikram Goyal
Modified: 2016-05-16 03:58 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-05-16 03:58:42 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Vikram Goyal 2016-01-30 02:05:30 UTC
For the current public preview guides of AEP [1], we have received the following enhancement requests via email from Bob Kozdemba:

For the Getting Started Guide [2]:

"
In step 9, we're missing an important part of testing in the customer experience. The customer is likely going to want to test a web app from a browser, but in order to do that they will need to configure the router layer. That isn't documented here, but it is (confusingly) in the openshift docs. So, essentially what we need to do here is explain how to configure the router layer and test an application from a browser. We could (hopefully?) re-use the openshift docs via single sourcing (??)
"

For the Install Guide [3]:

"
- it's confusing to have a "getting started" guide and an "install guide". I think this is a common problem for us. Can we name these in such a way that it's obvious which one you start with? Or, should they be combined?

- Section 1.2.4. skydns - is this needed? Sounds like this could be removed

- Section 1.2.5 - Can this example be fleshed out to show how to take a docker image from a registry and deploy with AEP

- Section 1.2.6 - This is the router bit from Step 9 in the GS guide. It doesn't say here how to set up the router, which needs to come first (before defining a route)

The use case that we want to document start to finish here is getting a docker image, deploying it, and testing via a browser
"

From Vikram: These issues will require clarification and input from Bilhar (content strategist). I am adding a needinfo for Bilhar so we can work together to arrive at a particular use case. We will also need to leverage the OSE Guides.


[1] https://access.redhat.com/documentation/en/red-hat-atomic-enterprise-platform/
[2] https://access.redhat.com/documentation/en/red-hat-atomic-enterprise-platform/version-3.1/getting-started-guide/
[3] https://access.redhat.com/documentation/en/red-hat-atomic-enterprise-platform/version-3.1/installation-and-configuration-guide/

Comment 6 Vikram Goyal 2016-02-25 06:23:58 UTC
*** Bug 1277806 has been marked as a duplicate of this bug. ***

Comment 7 Vikram Goyal 2016-02-25 06:27:11 UTC
*** Bug 1272324 has been marked as a duplicate of this bug. ***

Comment 8 Vikram Goyal 2016-02-25 06:28:47 UTC
*** Bug 1277803 has been marked as a duplicate of this bug. ***

Comment 9 Vikram Goyal 2016-02-25 06:29:53 UTC
*** Bug 1277797 has been marked as a duplicate of this bug. ***

Comment 10 Vikram Goyal 2016-02-25 06:30:49 UTC
*** Bug 1277802 has been marked as a duplicate of this bug. ***

Comment 11 Vikram Goyal 2016-02-25 06:34:34 UTC
*** Bug 1277810 has been marked as a duplicate of this bug. ***

Comment 12 Vikram Goyal 2016-02-25 06:35:19 UTC
*** Bug 1277811 has been marked as a duplicate of this bug. ***

Comment 13 Vikram Goyal 2016-02-25 06:35:56 UTC
*** Bug 1277807 has been marked as a duplicate of this bug. ***

Comment 14 Vikram Goyal 2016-02-25 06:36:35 UTC
*** Bug 1277808 has been marked as a duplicate of this bug. ***

Comment 15 Vikram Goyal 2016-02-25 06:37:20 UTC
*** Bug 1277804 has been marked as a duplicate of this bug. ***

Comment 23 Vikram Goyal 2016-05-12 11:54:07 UTC
Moving this to release pending.

Comment 24 Vikram Goyal 2016-05-16 03:58:42 UTC
Docs for this are now released: https://access.redhat.com/documentation/en/red-hat-atomic-enterprise-platform/.

Moving this bug to CLOSED-->CURRENTRELEASE.


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