ManageIQ guides is a documentation repository that provides developer setup instructions, technical guidelines, and architectural reference material for the ManageIQ cloud management platform.
The repository addresses the need for centralized, comprehensive documentation to help developers set up development environments, understand the codebase architecture, and follow project standards. It covers practical setup paths including development appliance configuration, Vagrant-based virtual machine development, and plugin development across ManageIQ's split repository structure. The guides include provider-specific setup instructions for major cloud platforms like Amazon AWS, OpenStack, and Kubernetes, alongside debugging tools and test suite execution procedures.
Developers working on ManageIQ or its providers should use these guides as their primary reference for onboarding and ongoing development. The repository suits teams building cloud management solutions or extending ManageIQ through custom providers and plugins. It includes both foundational setup documentation and deeper technical material on architecture, REST API integration, and UI customization patterns, making it valuable for contributors at different experience levels with the platform.
The project's issue tracker shows sustained focus on documentation enhancements and maintenance of pinned reference materials, indicating ongoing effort to keep guidance current and accessible for the developer community.