This repository includes the following MidoNet documentation:
-
MidoNet Operation Guide
-
MidoNet Quick Start Guide for RHEL 7 / Icehouse (OSP)
-
MidoNet Quick Start Guide for RHEL 7 / Juno (OSP)
-
MidoNet Quick Start Guide for RHEL 7 / Juno (RDO)
-
MidoNet Quick Start Guide for RHEL 7 / Kilo (RDO)
-
MidoNet Quick Start Guide for Ubuntu 14.04 / Icehouse
-
MidoNet Quick Start Guide for Ubuntu 14.04 / Juno
-
MidoNet Quick Start Guide for Ubuntu 14.04 / Kilo
-
MidoNet Reference Architecture
-
MidoNet REST API
-
MidoNet Troubleshooting Guide
The documentation is written in AsciiDoc. Consult the MidoNet Wiki for instructions on how to contribute.
To build the whole project, run build.sh
from the base directory.
See the Toolchain README for technical details and how to build the docs.
Directory | Purpose |
---|---|
|
Maven project files |
|
Document sources |
|
Build tools |
|
WWW archive |
The build
directory contains the documents' Maven project files, each located
in a sub directory specific to a certain document.
The docs
directory contains the document sources, each located in the src
directory of the specific document’s sub directory.
The tools
directory contains the source code of the midonet-docs-maven-plugin.
The www
directory contains an archive of the document versions that have been
published to the MidoNet Documentation web site. The web site links to the
"latest" subdirectory, which symlinks to the latest available document versions.
The www
directory contains the MidoNet Documentation web site’s landing page
files, as well as and archive of the document versions that have been published
in the docs
sub directory. This includes a latest
symlink that points to the
latest released MidoNet version’s documentation.
After a successful build, the outputs for a document can be found in the
target/docbkx/webhelp
directory underneath the document’s build
directory.
Quick Start Guide for Ubuntu 14.04 / Icehouse:
Purpose | Directory |
---|---|
Document sources |
|
Maven project file |
|
Outputs (HTML, PDF) |
|
Quick Start Guide for RHEL 7 / Icehouse:
Purpose | Directory |
---|---|
Document sources |
|
Maven project file |
|
Outputs (HTML, PDF) |
|
Operation Guide:
Purpose | Directory |
---|---|
Document sources |
|
Maven project file |
|
Outputs (HTML, PDF) |
|
REST API:
Purpose | Directory |
---|---|
Document sources |
|
Maven project file |
|
Outputs (HTML, PDF) |
|