Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1457176 - [RFE] Provide man page for foreman-rake and associated sub-commands
Summary: [RFE] Provide man page for foreman-rake and associated sub-commands
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Infrastructure
Version: 6.1.4
Hardware: x86_64
OS: Linux
medium
medium
Target Milestone: Unspecified
Assignee: satellite6-bugs
QA Contact: Lukas Pramuk
URL:
Whiteboard:
Depends On:
Blocks: 1122832 1288539
TreeView+ depends on / blocked
 
Reported: 2017-05-31 09:18 UTC by Stephen Wadeley
Modified: 2022-03-13 14:18 UTC (History)
10 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of: 1288539
Environment:
Last Closed: 2019-02-07 11:57:23 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Stephen Wadeley 2017-05-31 09:18:43 UTC
+++ This bug was initially created as a clone of Bug #1288539 +++

1. Proposed title of this feature request  
       Provide man pages for all satellite 6 commands and config files
      
      
    3. What is the nature and description of the request?  
     Some commands like katello-installer, capsule-certs-gen, hammer,...
     do have no man page but only --help or --full-help and in case 
     documentation for $config file is needed one has to look in online
     documentation, sometimes even upstream which makes it hard to understand
     which value is provided by Red Hat then

    4. Why does the customer need this? (List the business requirements here)  
     Aside the face that man pages are good practice to have for _all_
     commands _and_ config files it is not always possible to have a look at
     documentation on line, further on documentations and --help pages are  
     often lacking examples which normally can be found in man pages. Especially 
     for conf* files it is sometime not easy to understand what setting should/could be 
     used 
      
      
    5. How would the customer like to achieve this? (List the functional requirements here)  
    man pages for all commands provided by satellite should be available as well as
    for configuration files. In order to get an interim solution it would be one possibility
    to have man pages pointing to web pages where detailed information is available which
    would at least for config files help to understand them better
      
    6. For each functional requirement listed, specify how Red Hat and the customer can test to confirm the requirement is successfully implemented.  
       man $command ; man $config_file
      
    7. Is there already an existing RFE upstream or in Red Hat Bugzilla?  
     Found none
      
    8. Does the customer have any specific timeline dependencies and which release would they like to target (i.e. RHEL5, RHEL6)?  
     no
      
    9. Is the sales team involved in this request and do they have any additional input?  
     no
      
      
    10. Would the customer be able to assist in testing this functionality if implemented?  
     yes


Customer complaint that good old unix/linux style - to have man pages with examples - is not valued by Satellite6

--- Additional comment from Stephen Wadeley on 2017-01-28 05:54:42 EST ---

Hello Bryan

What is the correct BZ component for requesting man pages form engineering?

Should we turn this into a tracker bug and then clone for every package containing a command?

Thank you

--- Additional comment from Bryan Kearney on 2017-02-07 10:42:33 EST ---

We dont really have a good doc for this. Ack to using this as a tracker.

Comment 1 Mike McCune 2017-05-31 20:30:53 UTC
Reworded this to provide one man page for all of foreman-rake and the associated sub-commands we provide.

katello:reimport isn't a command itself, it is a sub-command of 'foreman-rake' so offering a man page needs to be at a higher level than the various options you can run from foreman-rake.

Comment 2 Stephen Wadeley 2017-05-31 20:33:05 UTC
thank you Mike

Comment 3 Brad Buckingham 2017-06-01 13:45:16 UTC
Assuming that this should document the various sub-commands provided by foreman-rake, I am moving this to the Infrastructure component.  I am not sure the best place for it; however, the solution will be broader than content.  Feel free to assign to another component, if another is more appropriate.

Comment 5 Bryan Kearney 2018-11-30 15:01:07 UTC
The Satellite Team is attempting to provide an accurate backlog of bugzilla requests which we feel will be resolved in the next few releases. We do not believe this bugzilla will meet that criteria, and have plans to close it out in 1 month. This is not a reflection on the validity of the request, but a reflection of the many priorities for the product. If you have any concerns about this, feel free to contact Rich Jerrido or Bryan Kearney or your account team. If we do not hear from you, we will close this bug out. Thank you.

Comment 6 Bryan Kearney 2019-01-04 13:18:19 UTC
The Satellite Team is attempting to provide an accurate backlog of bugzilla requests which we feel will be resolved in the next few releases. We do not believe this bugzilla will meet that criteria, and have plans to close it out in 1 month. This is not a reflection on the validity of the request, but a reflection of the many priorities for the product. If you have any concerns about this, feel free to contact Red Hat Technical Support or your account team. If we do not hear from you, we will close this bug out. Thank you.

Comment 7 Bryan Kearney 2019-02-07 11:57:23 UTC
Thank you for your interest in Satellite 6. We have evaluated this request, and while we recognize that it is a valid request, we do not expect this to be implemented in the product in the foreseeable future. This is due to other priorities for the product, and not a reflection on the request itself. We are therefore closing this out as WONTFIX. If you have any concerns about this, please do not reopen. Instead, feel free to contact Red Hat Technical Support. Thank you.


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