Uploaded image for project: 'openATTIC'
  1. openATTIC
  2. OP-634

Improve and expand the openATTIC documentation

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
    • Epic Name:
      oA Documentation

      Description

      From a high-level perspective, I think we should have the following top-level documents/main chapters:

      Introduction

      • openATTIC in a nutshell, key features
      • Common Use Cases for openATTIC (condense this to the cases we actually support)

      Installation and getting started

      • System requirements/Supported platforms
      • Basic OS preparation, Installation (separate for each supported platform)
      • Installing additional openATTIC modules
      • Installing a multi-node setup

      Administration Guide

      • Explaining the WebUI and how to perform common tasks

      Integration Guide

      • Explaining the REST API (including an API reference)
      • Update the Integration Tutorial to use the REST API
      • Remove incomplete/obsolete parts, e.g. "Cloud Connectors"

      Developer Guide

      • Included and update the existing developer documentation (e.g. Gatling-REST, e2e GUI tests)

        Attachments

          Activity

            People

            Assignee:
            Unassigned
            Reporter:
            lpaduano Paduano, Laura
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: