Uploaded image for project: 'Camel'
  1. Camel
  2. CAMEL-20459

EIP Documentation: grammar, typos and other fixes

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 4.4.0
    • 4.4.1, 4.5.0
    • documentation
    • Novice

    Description

      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. Go to src/main/docs/ on the core/camel-core-engine module.
      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:

      git log --oneline | egrep "CAMEL-20459"

      Note 3: Make sure the commit follows this pattern: 

      "CAMEL-20459: documentation fixes for component"

      Attachments

        1. grammar-problems.png
          97 kB
          Otavio Rodolfo Piske

        Activity

          People

            orpiske Otavio Rodolfo Piske
            orpiske Otavio Rodolfo Piske
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: