Uploaded image for project: 'Migration Toolkit for Virtualization'
  1. Migration Toolkit for Virtualization
  2. MTV-79

Restructure and Improve Documentation

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Major Major
    • 2.2.0
    • None
    • None
    • None
    • Restructure and Improve MTV Documentation
    • False
    • False
    • Hide
      I can run an installation in OpenShift with the guide. i know all the components that will be installed and the mission for each one. I know the requirements and where to get the information on how to install them. I have a checklist before starting, even a pre-flight check tool.
      I know the pre-requisites needed before starting a migration (target networks, storage, credentials required) to run a migration. I know what kind of workloads are recommended to run in the target environment (and I have links to the documents that provide that info). I can configure the providers and mappings to run the migrations.
      I know how the validation service works, which pieces will run it and how they will interact with the rest of the tool. I know how to find the rules currently available for migrations. I know the format for rules and have simple and complex examples for them. I have a list of information retrieved for validation service. I know how to extend the validation service to obtain information for rules not available.
      I have a view on the MTV application architecture. I have a good explanation on what components much be running and how to perform a health check that helps me ensure everything is installed and running fine. I know which information is required to review status of each component, how to obtain it and what looks as good output. I know what must gather does, which files will it retrieve and what content each one of them has.
      Show
      I can run an installation in OpenShift with the guide. i know all the components that will be installed and the mission for each one. I know the requirements and where to get the information on how to install them. I have a checklist before starting, even a pre-flight check tool. I know the pre-requisites needed before starting a migration (target networks, storage, credentials required) to run a migration. I know what kind of workloads are recommended to run in the target environment (and I have links to the documents that provide that info). I can configure the providers and mappings to run the migrations. I know how the validation service works, which pieces will run it and how they will interact with the rest of the tool. I know how to find the rules currently available for migrations. I know the format for rules and have simple and complex examples for them. I have a list of information retrieved for validation service. I know how to extend the validation service to obtain information for rules not available. I have a view on the MTV application architecture. I have a good explanation on what components much be running and how to perform a health check that helps me ensure everything is installed and running fine. I know which information is required to review status of each component, how to obtain it and what looks as good output. I know what must gather does, which files will it retrieve and what content each one of them has.
    • To Do
    • 0% To Do, 0% In Progress, 100% Done
    • Undefined

      We currently have all the documentation under one single document that is missing some content in order to make it mode useful for users.

      Let's restructure it into:

      • * Installation Guide-
      • User Guide
      • * Validation Rules Creation Guide-
      • * Architecture and Troubleshooting Guide-

      Update after meeting with Miguel, Fabien, Audrey, and Avital:

      • Maintain a single MTV guide
      • Move architecture modules (workflows, CRs) into Troubleshooting section
      • Update MTV splash page to provide a fuller description of the guide contents

              apinnick@redhat.com Avital Pinnick
              mperezco@redhat.com Miguel Perez Colino (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: