[
https://issues.apache.org/jira/browse/CAMEL-21040?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Otavio Rodolfo Piske updated CAMEL-21040:
-----------------------------------------
Fix Version/s: 4.8.0
(was: 4.5.0)
(was: 4.4.1)
> Review documentation: grammar, typos and other fixes
> ----------------------------------------------------
>
> Key: CAMEL-21040
> URL: https://issues.apache.org/jira/browse/CAMEL-21040
> Project: Camel
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 4.7.0
> Reporter: Otavio Rodolfo Piske
> Assignee: Otavio Rodolfo Piske
> Priority: Major
> Labels: help-wanted
> Fix For: 4.8.0
>
>
> In CAMEL-20410 we did a comprehensive review of the documentation for
> multiple components. Since 4.5.0 we added a few more. This is a ticket for
> the documentation review of those components.
> ---------- Original text from CAMEL-20410.
> The documentation for our components is full of minor mistakes that can be
> easily found using IntelliJ's grammar tool.
> To fix this issue, open the full project on IntellIj and follow these steps:
> 1. Choose a component and go to src/main/docs/
> 2. Open the file with the extension adoc.
> 3. On Intellij, in the problems tab, it will list several errors and problems
> 4. Ignore the errors (the items with the red icon)
> 5. Look for the grammar warnings (the ones with the green check icon
> underlined with red).
> *Note 1*: See the attachment named "grammar-problems" for an example.
> *Note 2*: Make sure to check what components have been already fixed. Use the
> following command to do so:
> {noformat}
> git log --oneline | egrep ".*documentation.*fixes|CAMEL-20410"
> {noformat}
> *Note 3*: Make sure the commit follows this pattern:
> {noformat}
> "CAMEL-20410: documentation fixes for component"
> {noformat}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
