-
Epic
-
Resolution: Unresolved
-
Major
-
None
-
None
-
RHDH Cookbooks for Plugin Developers
-
False
-
-
False
-
-
To Do
-
RHIDP-7905 - Cookbooks for Platform Engineers and Plugin Developers
-
QE Needed, Docs Needed, TE Needed, Customer Facing, PX Needed
-
-
EPIC Goal
- Getting started guide for bootstrapping new dynamic plugin projects
- Development environment setup instructions aligned with specific RHDH releases
- Local debugging procedures for both isolated and integrated plugin testing
- Comprehensive testing strategies (unit, integration, end-to-end)
- Packaging and publishing processes for dynamic plugins
- Configuration and integration examples for various use cases
- Troubleshooting guide with FAQ and common issues resolution
- CLI tooling documentation for streamlined development workflows
Background/Feature Origin
- Extend existing documentation with real-world scenarios, implementation approaches, and operational best practices
- Establish a centralized knowledge base that bridges the gap between high-level documentation and hands-on implementation
Why is this important?
- Initial phase delivered via Google Docs for dynamic collaboration
- Component and team mapping for chapter ownership
- Inventory of existing documentation to avoid duplication
- Final delivery format to be determined (techdocs, product documentation, KB articles)
- Cookbooks must contain executable, copy-paste ready commands and procedures for manual validation
- Content structure should support future integration into automated testing frameworks for RHDH releases
User Scenarios
- Cookbooks must address real-world enterprise deployment scenarios
- Air-gapped environment considerations must be included for security-conscious organizations
- Multi-cloud deployment scenarios should be covered for hybrid environments
- Role-based access patterns should reflect common enterprise organizational structures
- Integration examples should cover commonly used enterprise tools and systems
Dependencies (internal and external)
Acceptance Criteria
- Getting started guide for bootstrapping new dynamic plugin projects
- Development environment setup instructions aligned with specific RHDH releases
- Local debugging procedures for both isolated and integrated plugin testing
- Comprehensive testing strategies (unit, integration, end-to-end)
- Packaging and publishing processes for dynamic plugins
- Configuration and integration examples for various use cases
- Troubleshooting guide with FAQ and common issues resolution
- CLI tooling documentation for streamlined development workflows
