Feature #7453

Add hammer man page

Added by Dominic Cleal over 3 years ago. Updated over 1 year ago.

Status:Closed
Priority:High
Assigned To:Shlomi Zadok
Category:Documentation
Target version:hammer-cli 0.7.0
Difficulty: Bugzilla link:1135146
Found in release: Pull request:https://github.com/theforeman/hammer-cli/pull/163, https://github.com/theforeman/hammer-cli/pull/210
Story points-
Velocity based estimate-

Description

Description of problem:
There's no manual for hammer

How reproducible:
always

Steps to Reproduce:
1. man hammer
2.
3.

Actual results:
no manpage

Expected results:
manpage

Additional info:
there's "hammer | more" and help options in the shell but it needs a proper manpage with usage, commands / options and explanations

Associated revisions

Revision 4d0caeb3
Added by Shlomi Zadok over 1 year ago

fixes #7453 - Adds man page to hammer (#163)

Revision 0e555929
Added by Dominic Cleal over 1 year ago

refs #7453 - explicitly list man page in gemspec files (#210)

Ensures that the man page is built and included in the gem if `gem
build` rather than `rake build` is used.

History

#1 Updated by Dominic Cleal over 3 years ago

I think this should be broken down into a core man page for "hammer", then each plugin can contribute their own man pages, e.g. "hammer-foreman" in the same style as git documentation.

#2 Updated by Bryan Kearney almost 3 years ago

  • Priority changed from Normal to High

Bumping this a bit. I agree with Dominic. As part of this issue, a standard should be put in place for how plugins should add their own man pages.

#3 Updated by Shlomi Zadok almost 3 years ago

  • Assigned To set to Shlomi Zadok
  • Pull request https://github.com/theforeman/hammer-cli/pull/163 added

#4 Updated by Eric Helms over 2 years ago

#5 Updated by Tomáš Strachota over 2 years ago

  • Status changed from New to Assigned

#6 Updated by Tomáš Strachota about 2 years ago

  • Target version set to hammer-cli 0.6.0

#7 Updated by Tomáš Strachota almost 2 years ago

  • Target version changed from hammer-cli 0.6.0 to hammer-cli 0.7.0

#8 Updated by Dominic Cleal over 1 year ago

#9 Updated by The Foreman Bot over 1 year ago

  • Status changed from Assigned to Ready For Testing

#10 Updated by Shlomi Zadok over 1 year ago

  • Status changed from Ready For Testing to Closed
  • % Done changed from 0 to 100

#11 Updated by The Foreman Bot over 1 year ago

  • Pull request https://github.com/theforeman/hammer-cli/pull/210 added

Also available in: Atom PDF