[
https://issues.apache.org/jira/browse/CAMEL-17926?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Claus Ibsen updated CAMEL-17926:
--------------------------------
Fix Version/s: 3.x
(was: 3.18.0)
> Spring Boot related documentation issues
> ----------------------------------------
>
> Key: CAMEL-17926
> URL: https://issues.apache.org/jira/browse/CAMEL-17926
> Project: Camel
> Issue Type: Task
> Components: camel-spring-boot-starters, documentation
> Affects Versions: 3.17.0
> Reporter: Zoran Regvart
> Priority: Major
> Fix For: 3.x
>
>
> During the recent troubleshooting of the differences between the
> documentation in Camel Spring Boot and Camel I've identified some long
> standing issues with the documentation.
> # To appease the referential integrity checks a placeholder [springdoc
> component
> |https://github.com/apache/camel/blob/04999556a32af90bd40548f04f89c215a193d8e6/components/camel-openapi-java/src/main/docs/springdoc.adoc]
> documentation was created. This should be removed and the SpringDoc Starter
> documentation should remain only visible via the Camel Spring Boot
> documentation.
> # DSLs in Camel do not include the Camel Spring Boot configuration snippet
> like the component documentation has. It should be added to the DSLs as they
> have starters much like the component documentation it includes now.
> # DSLs in Camel do not have the {{camel-spring-boot-name}} attribute, it
> should be set for the referential integrity to notice issues other than the
> mismatch in component vs starter counts.
> # Camel metadata JSON (in {{{}src/main/docs{}}}) is missing for debug,
> cloudevents and DSLs. It was manually copied over from the Camel project in
> [this
> commit|https://github.com/apache/camel-spring-boot/commit/503b25ce7024e71430a426badc828d76fe5eb345].
> Automation should be done to make sure those are present and updated with
> changes in the Camel repository.
> # DSL documentation doesn't appear in the Camel Spring Boot starter list
> page. It should be added, most likely as a separate section.
--
This message was sent by Atlassian Jira
(v8.20.7#820007)
