Uploaded image for project: 'Marathon'
  1. Marathon
  2. MARATHON-6983

README and REST documentation formatting improvement

    Details

    • Type: Task
    • Status: Resolved
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: None
    • Labels:

      Description

      Small formatting improvements to the README and REST documentation.

      For the README I've updated the bulk of it so that it wraps at 79 characters and also updated the formatting so that it reflects the way markdown actually renders the content.

      For the REST template, I've made similar changes and rebuilt REST.md. There were some differences I noticed in the output for three of the examples, specifically:

      • GET /v2/apps/ {app_id}/tasks
        - DELETE /v2/apps/{app_id}

        /tasks?host=

        {host}

        &scale=

        {true|false}
      • GET /v1/endpoints

      It appears this may just be a result of the template build process, but I thought I would point it out in case there is an issue here...

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              GitHub_lingmann lingmann (Inactive)
              Team:
              Orchestration Team
              Watchers:
            • Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: