Uploaded image for project: 'Razor (moved to puppet.atlassian.net)'
  1. Razor (moved to puppet.atlassian.net)
  2. RAZOR-182

Write user-focused man/help documentation for all commands

    XMLWordPrintable

Details

    • Improvement
    • Status: Closed
    • Normal
    • Resolution: Fixed
    • None
    • RAZOR 0.15.0
    • QA, Server
    • None
    • 3
    • April 9, April 23
    • Major

    Description

      We need to write user-focused manpage / help style documentation for all our commands. This should be markdown text, with a view to supplying this from the server to the client to support help output on that end.

      Unlike the existing API documentation, this should focus on how the command line tools would interact with the server, and user actions, not programatic details.

      Attachments

        Issue Links

          blocks

          Improvement - An improvement or enhancement to an existing feature or task. RAZOR-183 Define, document, and implement sending data about commands to the client from the server

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Closed
          relates to

          Improvement - An improvement or enhancement to an existing feature or task. RAZOR-179 Create command "DSL" and separate commands into their own classes/files

          • Normal - Regular issue, some loss of functionality under specific circumstances.
          • Closed

          Activity

            People

              phong Phong Ly
              daniel Daniel Pittman
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Zendesk Support