[CAMEL-14934] Improve Component, Language, Data format, etc. descriptions in Camel Catalog - ASF JIRA

Attach files

Attach Screenshot

Voters

Watch issue

Watchers

Create sub-task

Link

Clone

Update Comment Author

Replace String in Comment

Update Comment Visibility

Delete Comments

XML

Word

Printable

JSON

Details

Type: New Feature
Status: Resolved
Priority: Major
Resolution: Fixed
Affects Version/s: None
Fix Version/s: 3.3.0
Component/s: None
Labels:
None

Estimated Complexity:
Unknown

Description

The descriptions of components, languages, data formats, etc. in Camel catalog currently use several inconsistent styles. As agreed on camel-dev https://www.mail-archive.com/dev@camel.apache.org/msg50591.html we should try to stick to a common style characterized by the following rules:

Shorter is better. Less/shorter words are faster to read and faster to understand
(ii) An application of : Leave out words and information available elsewhere in the Catalog record. Esp. do not repeat the title and kind (component, language, ...) because they are clear from the context. The same holds for the word "Camel".
(iii) Concentrate on functionality (what it does), because that's what most users want to know; preferably start with a verb in the plain (imperative) form

Example:

old: JacksonXML data format is used for unmarshal a XML payload to POJO or to marshal POJO back to XML payload.

new: Unmarshal an XML payload to POJO or marshal a POJO back to XML.