Uploaded image for project: 'Razor'
  1. Razor
  2. RAZOR-182

Write user-focused man/help documentation for all commands

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Normal
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: RAZOR 0.15.0
    • Component/s: QA, Server
    • Labels:
      None
    • Template:
    • Epic Link:
    • Story Points:
      3
    • Sprint:
      April 9, April 23
    • UX Priority:
      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

            Activity

              People

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

                Dates

                Created:
                Updated:
                Resolved:

                  Zendesk Support