Bug 2212759

Summary:	Documentation for "hammer content-view component list" is obsolete : default output has changed.
Product:	Red Hat Satellite	Reporter:	Dorian Renard <drenard>
Component:	Hammer	Assignee:	Adam Lazik <alazik>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Satellite QE Team <sat-qe-bz-list>
Severity:	low	Docs Contact:
Priority:	unspecified
Version:	6.12.0	CC:	alazik, ofedoren
Target Milestone:	Unspecified	Keywords:	Documentation, Triaged
Target Release:	Unused
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-08-08 16:19:33 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 Dorian Renard 2023-06-06 09:13:14 UTC

Document URL: 
- https://access.redhat.com/documentation/fr-fr/red_hat_satellite/6.12/html/hammer_cli_guide/reference#hammer-content-view-component-list
- https://access.redhat.com/documentation/fr-fr/red_hat_satellite/6.13/html/hammer_cli_guide/reference#hammer-content-view-
component-list

Section Number and Name: 
- 2.20.3.2. hammer content-view component list

Describe the issue: 
Since Red Hat Satellite v6.12, the command "hammer content-view component list" has its default output changed. 

The --help option gives : 
- for v6.11

[root@momran-sat611serv-rhel8 ~]# hammer content-view component list --help
Usage:
    hammer content-view component <list|index> [OPTIONS]
 
Options:
 --composite-content-view VALUE     Name of the composite content view
 --composite-content-view-id NUMBER Composite content view id
 --fields LIST                      Show specified fields or predefined field sets only. (See below)
 --organization[-id|-label] VALUE   Organization name/label/id to search by
 -h, --help                         Print help
 
Predefined field sets:
  ----------------|-----|---------|-----
  FIELDS          | ALL | DEFAULT | THIN
  ----------------|-----|---------|-----
  Id              | x   | x       | x
  Name            | x   | x       |
  Version         | x   | x       |
  Current version | x   | x       |
  Version id      | x   | x       |
  ----------------|-----|---------|-----
 
Option details:
  Here you can find option types and the value an option can accept:
 
  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

- for a v6.12

[root@momran-sat612serv ~]# hammer content-view component list --help
Usage:
    hammer content-view component <list|index> [OPTIONS]
 
Options:
 --composite-content-view VALUE     Name of the composite content view
 --composite-content-view-id NUMBER Composite content view id
 --fields LIST                      Show specified fields or predefined field sets only. (See below)
 --organization[-id|-label] VALUE   Organization name/label/id to search by
 -h, --help                         Print help
 
Predefined field sets:
  ----------------|-----|---------|-----
  FIELDS          | ALL | DEFAULT | THIN
  ----------------|-----|---------|-----
  Content view id | x   | x       |
  Name            | x   | x       |
  Version         | x   | x       |
  Component id    | x   | x       | x
  Current version | x   | x       |
  Version id      | x   | x       |
  ----------------|-----|---------|-----
 
Option details:
  Here you can find option types and the value an option can accept:
 
  BOOLEAN             One of true/false, yes/no, 1/0
  DATETIME            Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
  ENUM                Possible values are described in the option's description
  FILE                Path to a file
  KEY_VALUE_LIST      Comma-separated list of key=value.
                      JSON is acceptable and preferred way for such parameters
  LIST                Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
                      JSON is acceptable and preferred way for such parameters
  MULTIENUM           Any combination of possible values described in the option's description
  NUMBER              Numeric value. Integer
  SCHEMA              Comma separated list of values defined by a schema.
                      JSON is acceptable and preferred way for such parameters
  VALUE               Value described in the option's description. Mostly simple string

But the associated documentation still gives old informations. 

Suggestions for improvement: 
- update v6.12 and v6.13 documentation
- update v6.12 release notes

Additional information:

Comment 1 Marie Hornickova 2023-06-07 11:02:15 UTC

Hello,
Thank you very much for reporting this issue.
The bug will go through proper tea mtriage and relevant updates will be shared in this ticket.
Thank you!

Comment 2 Adam Lazik 2023-08-08 14:00:04 UTC

Hello!
Created and merged PR to update the docs:
https://gitlab.cee.redhat.com/satellite-6-documentation/docs-Red_Hat_Satellite_6/-/merge_requests/1731

Currently waiting for Pantheon to reflect changes so I can provide link to the new docs.

Comment 3 Adam Lazik 2023-08-08 16:19:33 UTC

The documentation has been updated:
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.12/html-single/hammer_cli_guide/index#hammer-content-view-component-list
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.13/html-single/hammer_cli_guide/index#hammer-content-view-component-list