Documentation for the ManageIQ Management Platform
Clone or download
adahms Merge pull request #966 from adahms/Update_Azure_Instructions_hammer
Updated the installation instructions for Azure
Latest commit bca723a Sep 19, 2018
Failed to load latest commit information.
_images Update images and basic index for ManageIQ Oct 22, 2015
_javascripts Update to AsciiBinder v0.1.0 Oct 22, 2015
_stylesheets asciibinder.css needs to include the font-awesome.min css from CDN. Oct 23, 2015
_templates Article title must be quoted due to trailing colons Oct 12, 2016
api Fix brackets on add/remove resource on service Aug 1, 2018
art-Assigning_Custom_Analysis_Profile_to_VM Initial update to version numbers. Jun 11, 2018
art-Creating_a_Service_for_VM_Provisioning Added links to new example use case docs in related sections, and oth… Jul 2, 2018
art-Service_Provisioning_Using_an_Orchestration_Template Added xref Jun 29, 2018
auth Add support for OpenID-Connect (OIDC) Aug 6, 2018
common fix typo Sep 2, 2018
doc-Appliance_Hardening_Guide revision Sep 11, 2018
doc-Deployment_Planning_Guide Minor edits based on SME feedback. Aug 20, 2018
doc-General_Configuration Merge pull request #902 from suyogsainkar/BZ1590042-adv-settings-master Jul 19, 2018
doc-High_Availability_Guide update with SME feedback Sep 17, 2018
doc-Infrastructure_Migration_Solution_Guide/cfme Merge pull request #959 from apinnick/BZ#1627793 Sep 12, 2018
doc-Installing_on_AWS Initial update to version numbers. Jun 11, 2018
doc-Installing_on_Google_Compute_Engine Initial update to version numbers. Jun 11, 2018
doc-Installing_on_Microsoft_Azure Converted explicit references to downstream versions to samples. Sep 19, 2018
doc-Installing_on_OpenShift_Container_Platform a few small edits to formatting and markup Jul 5, 2018
doc-Installing_on_Red_Hat_Enterprise_Linux_OpenStack_Platform Initial update to version numbers. Jun 11, 2018
doc-Installing_on_Red_Hat_Virtualization add note with link to RHV procedure Aug 29, 2018
doc-Installing_on_SCVMM applied peer review changes Aug 10, 2018
doc-Installing_on_VMware_vSphere Initial update to version numbers. Jun 11, 2018
doc-Integration_with_AWS_CloudFormation_and_OpenStack_Heat Initial update to version numbers. Jun 11, 2018
doc-Integration_with_OpenShift_Container_Platform Initial update to version numbers. Jun 11, 2018
doc-Integration_with_ServiceNow Initial update to version numbers. Jun 11, 2018
doc-Managing_Authentication made updates from review Aug 8, 2018
doc-Managing_Infrastructure_and_Inventory fix typo Sep 13, 2018
doc-Managing_Providers updated with reviewer feedback Aug 16, 2018
doc-Methods_Available_for_Automation Initial update to version numbers. Jun 11, 2018
doc-Monitoring_Alerts_and_Reporting Applied peer review edits. Jul 9, 2018
doc-Policies_and_Profiles_Guide Minor rewording. Jul 30, 2018
doc-Provisioning_Virtual_Machines_and_Hosts Merge pull request #946 from cbudz/BZ1591599 Aug 24, 2018
doc-QuickStart_OpenStack_Provider_Guide Initial update to version numbers. Jun 11, 2018
doc-REST_API add delete datastore example Aug 22, 2018
doc-Scripting_Actions added the note to a second guide; added into about being admin to run… Aug 3, 2018
doc-Self_Service_User_Interface_Guide Initial update to version numbers. Jun 11, 2018
install/installing_on_rhev editing build file; changing install docs dir Mar 22, 2016
methods_available_for_automation Reverted some changes of 4.5 to 4.6 in accordance with peer review fe… Aug 24, 2017
welcome Remove unneeded stuff and cleanup welcome page Oct 22, 2015
.gitignore Updated .gitignore with global ignores for downstream build directories Aug 11, 2016
.travis.yml Bump to ruby 2.4.4 for great justice May 17, 2018 Update for standardization Aug 31, 2017
Gemfile Add Gemfile May 12, 2016
LICENSE.txt Cleanup README and add a LICENSE Feb 12, 2016 fix typo Aug 9, 2018
Rakefile Update distro_map for euwe branch Oct 7, 2016
_distro_map.yml Update distro_map for gaprindashvili Oct 31, 2017
_topic_map.yml Add support for OpenID-Connect (OIDC) Aug 6, 2018
index-community.html More cleanup due to upgrade to AsciiBinder Oct 22, 2015

ManageIQ Documentation

Build Status Gitter

This repo contains the documentation for


The documentation in this repository is built and deployed using AsciiBinder. If you're new to AsciiBinder, head over there and read up on how to contribute documentation.

Documentation follows a modular-based content model, providing a structure for writing and presenting user-story-based documentation. User-story-based documentation attempts to address the reader's needs more than focusing on feature-based documentation. This is accomplished using a set of templates for concepts, references, procedures and assemblies.

Templates can be found here.

Quick setup

  • Be sure to have Ruby installed with the bundler gem (if you don't have bundler, just run gem install bundler)
  • Clone the manageiq_docs repo.
  • cd into the new manageiq_docs repo directory.
  • bundle install
  • bundle exec ascii_binder - This will build the documentation into the _preview directory
  • open _preview/manageiq/master/welcome/index.html

Alternately, if you want to "live edit" the docs, replace the last two steps with:

  • Install the LiveReload browser extension:
  • bundle exec ascii_binder watch
  • open _preview/manageiq/master/welcome/index.html
  • Go to the open page in the browser and enable the LiveReload extension for that page.
  • Edit the docs. When you save, it will auto-build and then the webpage will reload automatically showing your changes.


For questions or comments about the documentation system, try one of the following:


Creative Commons License

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. See LICENSE.txt.