Files
tripleo-docs/doc/source/index.rst
James Slagle 500c14a965 Add source admonition
Using puppet modules from source is no longer required. However, it's
still useful to document how to do so for those that want to. This
creates a new source admonition that can be used to document such
things.

Change-Id: I5393bbfca51ebe97065995123a3d59a8719aaa81
2015-09-22 16:00:01 -04:00

1.9 KiB

Welcome to documentation

Contents:

Introduction <introduction/introduction> Environment Setup <environments/environments> Undercloud Installation <installation/installation> Basic Deployment (CLI) <basic_deployment/basic_deployment_cli> Basic Deployment (GUI) <basic_deployment/basic_deployment_gui> Advanced Deployment <advanced_deployment/advanced_deployment> Post Deployment <post_deployment/post_deployment> Troubleshooting <troubleshooting/troubleshooting> How to Contribute <contributions/contributions>

Documentation Conventions

Some steps in the following instructions only apply to certain environments, such as deployments to real baremetal and deployments using RHEL. These steps are marked as follows:

RHEL

Step that should only be run when using RHEL

RHEL Portal Registration

Step that should only be run when using RHEL Portal Registration

RHEL Satellite Registration

Step that should only be run when using RHEL Satellite Registration

CentOS

Step that should only be run when using CentOS

Baremetal

Step that should only be run when deploying to baremetal

Virtual

Step that should only be run when deploying to virtual machines

Ceph

Step that should only be run when deploying Ceph for use by the Overcloud

Source

Step that should only be run when choosing to use some components directly from their git source code repositories instead of packages.

Any such steps should not be run if the target environment does not match the section marking.