Claus Ibsen created CAMEL-26609:
-----------------------------------
Summary: docs - the component pages show their DST worlds (the
dstWorlds of the catalog) in a section
Key: CAMEL-26609
URL: https://issues.apache.org/jira/browse/CAMEL-26609
Project: Camel
Issue Type: Improvement
Components: documentation
Reporter: Claus Ibsen
Fix For: 4.24.0
CAMEL-26438 (#28787) lists the fake worlds of the deterministic simulation
tests in the catalog: a {{dstWorlds}} section in the component JSON, from the
{{@DstWorld}} annotation of each world class. Today five components have one:
aws2-sqs, azure-eventhubs, kafka-share, pulsar and slack.
The worlds show on the camel-test-dst page (the table there is generated from
the catalog) and in the Camel Catalog page of the user manual, but not on the
page of the component itself. A reader of the aws2-sqs page cannot see that its
consumer has a DST world, what it covers, or which tests run it.
Add a section, for example "Deterministic simulation tests", to the component
pages, rendered from {{$.dstWorlds}} of the component JSON. Do it the same way
as the Message Body section (CAMEL-24961,
{{docs/components/modules/ROOT/partials/body-types.adoc}}): from the shared
partial that every component page already includes
({{component-endpoint-headers.adoc}}), with the generic jsonpath extension of
camel-website, so no component adoc needs editing and the section only shows
when the component has a world. That is likely a change in the camel repo only;
nothing needed in camel-website.
Per world, show:
* the world class and the fake of the external system ({{fake}});
* what it covers ({{covers}}), the faults it injects ({{faults}}) and the
invariants it checks ({{invariants}});
* the JIRA issues ({{issues}}) and the DST tests that run it ({{tests}});
* a link to the camel-test-dst page (the guide, and how to run the tests).
{{javaType}} is a test class that is in no JAR, so show its simple name and do
not link it as an API class.
Remember to regenerate the catalog copies of the docs, and check the result in
a local website build before the PR.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)
