Uploaded image for project: 'Puppet'
  1. Puppet
  2. PUP-10502

Use puppet help to generate ronn output

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: PUP 6.16.0
    • Component/s: None
    • Labels:
    • Template:
    • Team:
      Coremunity
    • Sprint:
      Platform Core KANBAN
    • Release Notes:
      Enhancement
    • Release Notes Summary:
      Adds a `puppet help <app> --ronn` command line option to generate help text for an application in ronn format. This eliminates the need for `puppet man` which is deprecated and will be removed in Puppet 7.
    • QA Risk Assessment:
      Needs Assessment

      Description

      Puppet docs tooling runs puppet man to produce ronn output for each application and converts that to html using the ronn gem. See https://github.com/puppetlabs/puppet-docs/blob/e09308ea830fbeb97a2702dd0b46c89a8d2af954/lib/puppet_references/puppet/man.rb#L120. We need to provide a way to generate the same output without relying on the puppet man application which will be removed in puppet 7

        Attachments

          Issue Links

          blocks

          Task - A task that needs to be done. PUP-8446 Remove "puppet man" face application

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Ready for Merge

            Activity

              People

              Assignee:
              josh Josh Cooper
              Reporter:
              josh Josh Cooper
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support