% Start Here
% 
% January, 2011

-   Preface
-   Documentation Contents
-   Using the Documentation
-   Online Documentation
-   Contacting Deployit Support
-   Quickstart

# Preface

Welcome to the Deployit system documentation. This document
describes the content of the Deployit documentation and helps you
find the information you need.

# Documentation Contents

The Deployit documentation contains all the information needed to
install, configure, setup and use Deployit. The documentation
consists of the following documents:

-   **Start Here**. This is the document you are currently reading.
-   **Reference Manual**. This document describes generic
    deployment concepts and basic information about Deployit.
-   **System Administration Manual**. This document describes how
    to install Deployit and get it ready for first use.
-   **Graphical User Interface (GUI) Manual**. This document
    describes how to use the Deployit GUI.
-   **Command Line Interface (CLI) Manual**. This document
    describes how to use the Deployit CLI.
-   **Packaging Manual**. This document describes how to create
    packages that can be imported into Deployit.
-   **Tomcat Plugin Manual**. This document describes the features
    of the Deployit Tomcat plugin. [^1]
-   **JBoss Plugin Manual**. This document describes the features
    of the Deployit JBoss plugin. [^2]
-   **WAS Plugin Manual**. This document describes the features of
    the Deployit WebSphere Application Server plugin. [^3]
-   **WebLogic Server Plugin Manual**. This document describes the
    features of the Deployit WebLogic Server plugin. [^4]
-   **WebSphere MQ Plugin Manual**. This document describes the
    features of the Deployit WebSphere MQ plugin. [^5]
-   **WebSphere Portal Plugin Manual**. This document describes the
    features of the Deployit WebSphere Portal plugin. [^6]
-   **Oracle Service Bus Plugin Manual**. This document describes
    the features of the Deployit Oracle Service Bus plugin. [^7]
-   **Implementation Manual**. This document describes the
    customizations that were made to Deployit by XebiaLabs staff during
    a POC or implementation. [^8]

# Using the Documentation

Every document is written as a standalone document and can be read
separately. References to other documents are included when
relevant. Depending on your role, some documents are more relevant
than others. The following list contains a suggested reading order
for specific roles:

-   **System Administrator**: Reference Manual, System
    Administration Manual, Command Line Interface (CLI) Manual.
-   **Deployer**: Reference Manual, Packaging Manual, Command Line
    Interface (CLI) Manual.
-   **Developer**: Reference Manual, Packaging Manual, Graphical
    User Interface (GUI) Manual.
-   **Manager**: Reference Manual, Graphical User Interface (GUI)
    Manual.

# Online Documentation

There is also an online version of the documentation at
[XebiaLabs' documentation site](http://docs.xebialabs.com). The
documentation site contains the latest and most up-to-date copy of
the documentation.

# Contacting Deployit Support

To contact Deployit support, use our
[support desk](http://support.xebialabs.com).

# Quickstart

If you're impatient to get started using Deployit, here is a quick
rundown of steps you'll need to take and where to find the relevant
information:

-   **Install Deployit**: see **System Administration Manual**,
    section *Installation Procedure*.
-   **Setup your environment**: see
    **System Administration Manual**, section *Setting up Deployit*.
-   **Import the PetClinic sample application**: see
    **Graphical User Interface (GUI) Manual**, section
    *Importing Packages* or **Command Line Interface (CLI) Manual**,
    section *Performing a Simple Deployment*.
-   **Deploy the PetClinic sample application**: see
    **Graphical User Interface (GUI) Manual**, section
    *Initial deployment* or **Command Line Interface (CLI) Manual**,
    section *Performing a Simple Deployment*.


[^1]:
    This manual is only available if the plugin is part of your
    Deployit installation.

[^2]:
    This manual is only available if the plugin is part of your
    Deployit installation.

[^3]:
    This manual is only available if the plugin is part of your
    Deployit installation.

[^4]:
    This manual is only available if the plugin is part of your
    Deployit installation.

[^5]:
    This manual is only available if the plugin is part of your
    Deployit installation.

[^6]:
    This manual is only available if the plugin is part of your
    Deployit installation.

[^7]:
    This manual is only available if the plugin is part of your
    Deployit installation.

[^8]:
    This manual may not be available depending on the installation at
    your site.


