[CAMEL-17926] Spring Boot related documentation issues

• Type: Task
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 3.17.0
• Fix Version/s: 4.x
• Component/s: camel-spring-boot-starters, documentation
• Estimated Complexity: Unknown
• Assignee: Unassigned
• Reporter: Zoran Regvart
• Created: 07/Apr/22 15:07
• Updated: 09/Aug/23 09:11

Description

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.

1. To appease the referential integrity checks a placeholder springdoc component documentation was created. This should be removed and the SpringDoc Starter documentation should remain only visible via the Camel Spring Boot documentation.
2. 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.
3. 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.
4. 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. Automation should be done to make sure those are present and updated with changes in the Camel repository.
5. DSL documentation doesn't appear in the Camel Spring Boot starter list page. It should be added, most likely as a separate section.