rhdh-mermaid-techdocs-addon
v1.0.0
Published
Dynamic plugin wrapper for RHDH that enables Mermaid diagrams in TechDocs
Maintainers
Readme
rhdh-techdocs-mermaid-addon
Dynamic plugin wrapper para Red Hat Developer Hub que habilita el soporte de diagramas Mermaid en TechDocs.
🎯 Propósito
Este plugin resuelve el problema de que RHDH no incluye el addon de Mermaid por defecto. Permite usar diagramas Mermaid en TechDocs en entornos de OpenShift donde no se pueden instalar paquetes npm directamente.
📦 ¿Qué hace este plugin?
- Wrappe el addon oficial: Incluye
backstage-plugin-techdocs-addon-mermaidcomo dependencia - Compatible con dynamic plugins: Se instala como dynamic plugin en RHDH
- Configuración automática: Se integra automáticamente con TechDocs existente
🚀 Instalación en RHDH
Opción 1: Via Helm Chart
global:
dynamic:
includes:
- dynamic-plugins.default.yaml
plugins:
- package: 'rhdh-techdocs-mermaid-addon@^2.0.2'
integrity: 'sha512-R0XRmPTkfH0rrp3QSEEgwj8CvDMKlVGukluFeQrVEngCidmP6Jl/xo+VtA3kB6hQ2/71hHmBJUB6nKd0pxa3PQ=='
disabled: falseOpción 2: Via ConfigMap (Operator)
kind: ConfigMap
apiVersion: v1
metadata:
name: dynamic-plugins-rhdh
data:
dynamic-plugins.yaml: |
includes:
- dynamic-plugins.default.yaml
plugins:
- package: 'rhdh-techdocs-mermaid-addon@^2.0.2'
integrity: 'sha512-R0XRmPTkfH0rrp3QSEEgwj8CvDMKlVGukluFeQrVEngCidmP6Jl/xo+VtA3kB6hQ2/71hHmBJUB6nKd0pxa3PQ=='
disabled: false📝 Uso
Una vez instalado, los diagramas Mermaid funcionarán automáticamente en TechDocs:
```mermaid
graph TD
A[Start] --> B{Decision}
B -->|Yes| C[Action 1]
B -->|No| D[Action 2]
C --> E[End]
D --> E
```✅ Verificación
- Ve a Administration > Plugins en RHDH
- Busca
rhdh-techdocs-mermaid-addon - Verifica que aparezca como "Loaded"
🔧 Desarrollo
npm install
npm run build
npm publish --access public📚 Compatibilidad
- ✅ Red Hat Developer Hub 1.x
- ✅ OpenShift 4.x
- ✅ Backstage 1.11+
