Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.
This project is now read‑only. Starting Monday, February 2, please use https://ibm-ceph.atlassian.net/ for all bug tracking management.

Bug 1640383

Summary: Tabular representation of ceph-ansible options is not pleasing and hard to read
Product: [Red Hat Storage] Red Hat Ceph Storage Reporter: Dan Mick <dmick>
Component: DocumentationAssignee: Fionn Kelleher <fkellehe>
Documentation sub component: Install Guide QA Contact: Manasa <mgowri>
Status: CLOSED EOL Docs Contact:
Severity: low    
Priority: low CC: asriram, fkellehe, hyelloji, kdreyer, trchakra, vereddy
Version: 6.0Keywords: Reopened
Target Milestone: ---   
Target Release: Backlog   
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: 2023-11-27 04:42: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:

Description Dan Mick 2018-10-17 23:28:46 UTC 
Description of problem:
Tabular representation of ceph-ansible options is not pleasing and hard to read

Version-Release number of selected component (if applicable):

Table 3.1 in 

https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/3/html/installation_guide_for_ubuntu/deploying-red-hat-ceph-storage#installing-a-red-hat-ceph-storage-cluster


Additional info:

It seems to me this would be better as a multi-paragraph list, with four headings for each, like:

Option:
Value:
Required:
Notes:

than trying to fit it into the table, because it really doesn't fit; even with the browser at full-screen width, there are only about 600 pixels available for the whole table (150-ish for each column) and basically everything wraps really badly.
Comment 4 Dan Mick 2018-10-26 22:35:45 UTC 
I very much doubt any table width will accommodate this info; I think a table is just the wrong presentation format
Comment 6 Dan Mick 2018-12-12 23:27:45 UTC 
Sorry for the delay; I saw the email for the bug update on my phone and couldn't access the server to see it, and then forgot.

That is better in spirit as it can handle long items, although I think the style gets clunky with all the nested indenting.  Dropping "Description" as a section title and maybe putting things that fit on one line (like "Type: Integer" and "Example: 2") would be easier to read.
Comment 7 John Brier 2018-12-13 19:52:54 UTC 
Okay. That might be all we can do for now. Long term, the issue will hopefully be addressed in a more ideal way based on the links in comment #3. I will talk to the ceph-docs team to decide how we want to handle this short term.
Comment 8 John Brier 2018-12-18 15:47:27 UTC 
I talked to the ceph-docs team. We are going to discuss this more with out content strategist after RHCS 3.2 is released.
Comment 14 Giridhar Ramaraju 2019-08-05 13:05:51 UTC 
Updating the QA Contact to a Hemant. Hemant will be rerouting them to the appropriate QE Associate. 

Regards,
Giri
Comment 15 Giridhar Ramaraju 2019-08-05 13:08:36 UTC 
Updating the QA Contact to a Hemant. Hemant will be rerouting them to the appropriate QE Associate. 

Regards,
Giri
Comment 18 Dan Mick 2021-02-18 06:21:24 UTC 
can this ever actually be addressed?
Comment 19 Dan Mick 2021-04-28 20:00:51 UTC 
I guess the answer to the above question is "no"
Comment 26 Anjana Suparna Sriram 2023-02-15 14:30:36 UTC 
As this version of Ceph is not supported, closing the bug as WONTFIX.
Comment 27 Dan Mick 2023-02-15 21:10:02 UTC 
Did you verify that the issue no longer exists in the current release?
Comment 28 Red Hat Bugzilla 2023-09-18 00:14:38 UTC 
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 120 days
Comment 29 Dan Mick 2023-09-18 00:22:54 UTC 
Please investigate and resolve this five-year-old bug.  I didn't report it for a fun time.