Bug 2013632 - Correction/Changes in Quick Start Guides for ODF 4.9 (Install ODF guide)
Summary: Correction/Changes in Quick Start Guides for ODF 4.9 (Install ODF guide)
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Management Console
Version: 4.9
Hardware: Unspecified
OS: Unspecified
Target Milestone: ---
: 4.10.0
Assignee: Sanjal Katiyar
QA Contact: Yanping Zhang
Depends On:
Blocks: 2016028
TreeView+ depends on / blocked
Reported: 2021-10-13 12:25 UTC by Sanjal Katiyar
Modified: 2022-03-10 16:19 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Last Closed: 2022-03-10 16:19:33 UTC
Target Upstream Version:

Attachments (Terms of Use)

System ID Private Priority Status Summary Last Updated
Github openshift console-operator pull 598 0 None open Bug 2013632: Correction/Changes in Quick Start Guides for ODF 2021-10-13 12:27:45 UTC
Github openshift console-operator pull 608 0 None open Bug 2013632: Correct grammar error in ODF quickstart 2021-11-02 10:26:28 UTC
Red Hat Product Errata RHSA-2022:0056 0 None None None 2022-03-10 16:19:54 UTC

Description Sanjal Katiyar 2021-10-13 12:25:29 UTC
Description of problem:

Version-Release number of selected component (if applicable):
OCP 4.9.0-0.nightly-2021-09-10-170926 and ODF 4.9.0-139.ci

How reproducible:

Steps to Reproduce:
On the Overview tab under `Home', click on View all quick starts on Build with guided documentation tile.

GUIDE 1- Install the OpenShift Data Foundation
Install the OpenShift Data Foundation 1 of 2
Check your work
I don't see any verification steps mentioned currently, it is just asking for user input in the form of Yes/No.
Can we please add a small and simple verification step that will help the user while repeating the installation steps again? I know there can be several reasons for failure, but can we add something which is very generic and may help users to keep that in mind while repeating the installation.
Create a StorageSystem 2 of 2
3rd bullet point in under point 5 isn't very clear or self-explanatory and should be rephrased to:

Bullet point heading: Create a new storage class using an external storage array

It's description: Can be used on bare-metal infrastructures where nodes have access to the external storage array (e.g. via Fibre Channel or iSCSI). The infrastructure storage class is provided by a third-party CSI driver leveraging the external storage array (e.g. IBM Block CSI Driver). Important: The CSI driver must support block mode for the block devices it provisions.

These statements are suggested by @jelopez 
Please re-phrase it (if needed) so as to make it more short and precise and to better fit UI.

Check your work
Again, if we can add a genric, small, and simple step for the user to keep in mind while repeating the StorageSystem creation steps.

Actual results:
Few steps are missing. Some of the statements have grammatical mistakes. I also see scope to make this guide more user-friendly.

Expected results:
All the possible details are provided along with each issue mentioned above.

Additional info: Please refer https://bugzilla.redhat.com/show_bug.cgi?id=2004916 for more clarification and discussion around this issue.
Fix for #2004916 was across two repos, one is "odf-operator" and other to "console-operator".
So, #2004916 will handle fixes in "Getting Started" & "Configure and Management" guides and this new BZ will handle fixes in "Install" ODF guide.

Comment 4 Yanping Zhang 2021-11-01 07:53:20 UTC
Checked on ocp 4.10 cluster with payload 4.10.0-0.nightly-2021-10-31-133814. Updates look good except this sentence "Once your StorageSystem’s reaches a Ready status", seems a grammar error, should it be "Once your StorageSystem reaches a Ready status"?

Comment 7 Yanping Zhang 2021-11-04 04:34:09 UTC
Checked on ocp 4.10 cluster with payload 4.10.0-0.nightly-2021-11-03-181048, the grammar error has been fixed.

Comment 11 errata-xmlrpc 2022-03-10 16:19:33 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: OpenShift Container Platform 4.10.3 security update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.


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