Bug 2098235 - Commands that have an Example but no Syntax
Summary: Commands that have an Example but no Syntax
Keywords:
Status: ASSIGNED
Alias: None
Product: Red Hat Ceph Storage
Classification: Red Hat Storage
Component: Documentation
Version: 5.2
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: 5.3z5
Assignee: Anjana Suparna Sriram
QA Contact: Chaithra
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-06-17 16:39 UTC by lysanche
Modified: 2023-07-25 18:12 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHCEPH-4573 0 None None None 2022-06-17 16:42:18 UTC

Description lysanche 2022-06-17 16:39:53 UTC 
Describe the issue: Throughout the Object Gateway Guide, there are cases where there is an Example of a command, but there is no Syntax for that command. 

For several cases of this, see section 7.9.8. Enabling Object Lock for S3 under Command line options:
https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/object_gateway_guide/index#enabling-object-lock-for-S3_rgw

Describe the task you were trying to accomplish: Make sure that each command has both a Syntax and an Example.

Suggestions for improvement: Add the missing Syntax for each command that has only an Example.

Document URL: https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/5/html-single/object_gateway_guide/index

Chapter/Section Number and Title: Numerous

Product Version: 5.2

Environment Details:

Any other versions of this document that also needs this update:

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