The manageiq/guides repository serves as the central documentation hub for ManageIQ, an open-source cloud and infrastructure management platform. Written primarily in Ruby, this repository contains comprehensive guides and developer documentation accessible through the ManageIQ documentation portal at manageiq.org/docs/guides/README. The repository is classified across multiple domains including cloud management, infrastructure automation, virtualization, hybrid cloud solutions, and IT operations, reflecting its broad scope as a resource for both developers and operators.
The repository is organized into three primary documentation sections. The Setup section provides detailed instructions for getting ManageIQ running in various configurations, including development appliance setup, Vagrant VM-based development, and plugin development workflows. It covers provider-specific setup instructions for major cloud platforms including Amazon AWS, OpenShift, and OpenStack Infrastructure, along with guidance on interactive debugging using Pry-Remote, minimal mode operation, test suite execution, Cypress UI testing, and Kubernetes integration. The Developer Guidelines section establishes standards and processes for contributing to ManageIQ, encompassing the backport process, coding style standards, API contribution guidelines, external authentication configuration, Git utilities, issue and PR triage procedures, internationalization practices, merger guidelines, repository labeling conventions, reviewer expectations, and UI pattern documentation. The Technical Documentation section addresses architectural concepts, custom URL automation, report data APIs, remote console functionality, REST API references, service UI skinning, React component registration, and AWS Config service integration.
GitGenius activity tracking reveals that this repository maintains relatively low issue and PR response latency with a median of 0.0 hours across tracked items, though the mean of 854.9 hours indicates occasional delays on longer-running discussions. The most active contributor tracked is Fryguy with 5 events, followed by agrare and dmetzger57 with 1 event each. Enhancement requests and dependency management through Mend represent the primary issue categories. The repository maintains strong connections to other ManageIQ ecosystem repositories including manageiq/manageiq and manageiq/manageiq-ui-classic, as well as apollographql/apollo-client, indicating its role as documentation for a distributed project architecture.
The documentation is licensed under Creative Commons Attribution 3.0 Unported License, making it freely available for reference and reuse. The guides cover both operational aspects like deployment and configuration alongside development-focused content including plugin architecture, provider development patterns, and testing methodologies. This dual focus positions the repository as essential onboarding material for new contributors while simultaneously serving as a reference for operators managing ManageIQ installations across multi-cloud and hybrid cloud environments. The comprehensive nature of the guides reflects ManageIQ's complexity as a system integration and resource orchestration platform supporting multiple virtualization platforms and cloud providers.
