Skip to content

[RHIDP-9494]: Add CloudEvents and Kafka workflow integration documentation - #2137

Merged
pabel-rh merged 7 commits into
redhat-developer:mainfrom
jmagak:RHIDP-9494-cloudevents-kafka-workflows-docs
May 4, 2026
Merged

pabel-rh merged 7 commits into
redhat-developer:mainfrom
jmagak:RHIDP-9494-cloudevents-kafka-workflows-docs

Conversation

@jmagak

@jmagak jmagak commented Apr 29, 2026 •

Copy link
Copy Markdown
Member

@rhdh-bot

rhdh-bot commented Apr 29, 2026 •

Copy link
Copy Markdown
Collaborator

PR Build Results

Build passed -- 34/34 titles | 76s
Preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-2137/


Content Quality Assessment

CQA Report

  • CQA-00a: Orphaned modules
  • CQA-00b: Directory structure
  • CQA-01: Vale AsciiDoc DITA compliance
  • CQA-02: Verify assembly structure
  • CQA-03: Verify content type metadata
  • CQA-04: Verify module templates
  • CQA-05: Verify required modular elements
  • CQA-06: Verify assemblies follow official template (one user story)
  • CQA-07: Verify TOC depth (max 3 levels)
  • CQA-08: Verify short description content quality
  • CQA-09: Verify short description format
  • CQA-10: Verify titles are brief, complete, and descriptive
  • CQA-11: Verify procedure prerequisites
  • CQA-12: Verify grammar and style (Vale)
  • CQA-13: Verify content matches declared type
  • CQA-14: Verify no broken links
  • CQA-15: Check redirects
  • CQA-16: Verify official product names
  • CQA-17: Verify legal disclaimers for preview features

Summary

Checks: 19 total, 19 pass, 0 fail

19 checks: 19 pass, 0 fail

Run node build/scripts/cqa/index.js --all --fix locally to review and auto-fix issues.


Updated 2026-05-04 08:59:20 UTC

@jmagak
jmagak requested a review from lholmquist April 29, 2026 22:24
@jmagak
jmagak force-pushed the RHIDP-9494-cloudevents-kafka-workflows-docs branch from 4bdc629 to 6df6116 Compare April 30, 2026 00:54
@jmagak
jmagak force-pushed the RHIDP-9494-cloudevents-kafka-workflows-docs branch from cb1ccd9 to d9efdd0 Compare April 30, 2026 07:49
@jmagak
jmagak force-pushed the RHIDP-9494-cloudevents-kafka-workflows-docs branch from d9efdd0 to 32cd4c4 Compare April 30, 2026 09:45
@jmagak
jmagak force-pushed the RHIDP-9494-cloudevents-kafka-workflows-docs branch from 32cd4c4 to 4c52a44 Compare April 30, 2026 10:21
@jmagak jmagak added Peer review needed 📖 Technical review done ⛅ Any procedure has been succesfully tested and removed Technical review needed 🔩 Test all the procedures labels Apr 30, 2026

@rh-tokeefe rh-tokeefe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jmagak nice work on this PR! I provided one style implication for you to consdier. LGTM!

GitHub Actions and others added 7 commits May 4, 2026 10:56
…ation

Add comprehensive documentation for triggering Orchestrator workflows
using CloudEvents via Apache Kafka integration.

New content:
- Assembly: Integrate CloudEvents and Kafka with Orchestrator workflows
- Concept: CloudEvents and event-driven workflow execution
- Procedure: Configure Kafka connection for CloudEvent workflows
- Procedure: Trigger workflows as CloudEvents from the RHDH UI
- Reference: CloudEvent structure and Kafka topic mapping

Target release: RHDH 1.10.0

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
CQA-05: Fix non-standard block title
- Change ".CloudEvent attributes" to ".CloudEvent attribute descriptions"

CQA-09: Fix short description length violations
- con-cloudevents: Reduce abstract from 494 to 235 chars
- proc-configure-kafka: Reduce abstract from 331 to 215 chars
- Move additional context to separate paragraphs

CQA-10: Rename files and update IDs for title compliance
- assembly-integrate-cloudevents-kafka-workflows.adoc →
  assembly-integrate-cloudevents-and-kafka-with-orchestrator-workflows.adoc
- con-cloudevents-event-driven-workflows.adoc →
  con-cloudevents-and-event-driven-workflow-execution.adoc
- proc-configure-kafka-cloudevent-workflows.adoc →
  proc-configure-kafka-connection-for-cloudevent-workflows.adoc
- proc-trigger-workflows-cloudevents-ui.adoc →
  proc-trigger-workflows-as-cloudevents-from-the-rhdh-ui.adoc
- ref-cloudevent-structure-kafka-mapping.adoc →
  ref-cloudevent-structure-and-kafka-topic-mapping.adoc

Update all cross-references and includes to use new filenames and IDs.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@jmagak
jmagak force-pushed the RHIDP-9494-cloudevents-kafka-workflows-docs branch from badcc52 to 459c92c Compare May 4, 2026 08:56
@sonarqubecloud

sonarqubecloud Bot commented May 4, 2026

Copy link
Copy Markdown

@pabel-rh
pabel-rh merged commit 11fcf99 into redhat-developer:main May 4, 2026
6 checks passed

This branch was previously deployed

1 inactive deployment
internal — 459c92c9 Deployed May 4, 2026 by jmagak via authorize #9382
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants