Uploaded image for project: 'camunda BPM'
  1. camunda BPM
  2. CAM-10584

Improve documentation regarding POM content of SPIN libraries

    Details

    • Type: Task
    • Status: Ready
    • Priority: L3 - Default
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 7.12.0
    • Component/s: documentation
    • Labels:

      Description

      We believe that it could be confusing for an end user which spin libraries to use, due to inconsistency in the spin libraries mentioned in the below doc links. We believe that we should document the POM content of spin libraries more clearly, like when to use what.

      1. https://docs.camunda.org/manual/latest/user-guide/data-formats/configuring-spin-integration/
      2. https://docs.camunda.org/manual/latest/reference/spin/

      The following things should be clarified:

      • A hint at the implications of what relocating the dependencies like Jackson means in the case of camunda-spin-dataformat-all (e.g. non-shaded Jackson annotations in custom classes will not be picked up)
      • A hint when to use which dependency scope (provided vs compile)

        Activity

        garima.yadav Garima Yadav created issue -
        garima.yadav Garima Yadav made changes -
        Field Original Value New Value
        Link This issue is related to SUPPORT-6016 [ SUPPORT-6016 ]
        tassilo.weidner Tassilo Weidner made changes -
        Status Open [ 1 ] Ready [ 10005 ]
        garima.yadav Garima Yadav made changes -
        Assignee Thorben Lindhauer [ thorben.lindhauer ]
        thorben.lindhauer Thorben Lindhauer made changes -
        Description We believe that it could be confusing for an end user which spin libraries to use, due to inconsistency in the spin libraries mentioned in the below doc links. We believe that we should document the POM content of spin libraries more clearly, like when to use what.

        1. https://docs.camunda.org/manual/latest/user-guide/data-formats/configuring-spin-integration/
         2. https://docs.camunda.org/manual/latest/reference/spin/

        We believe that it could be confusing for an end user which spin libraries to use, due to inconsistency in the spin libraries mentioned in the below doc links. We believe that we should document the POM content of spin libraries more clearly, like when to use what.

        1. https://docs.camunda.org/manual/latest/user-guide/data-formats/configuring-spin-integration/
        2. https://docs.camunda.org/manual/latest/reference/spin/

        The following things should be clarified:

        * A hint at the implications of what relocating the dependencies like Jackson means in the case of {{camunda-spin-dataformat-all}}
        * A hint when to use which dependency scope {{provided}} vs {{compile}}
        thorben.lindhauer Thorben Lindhauer made changes -
        Description We believe that it could be confusing for an end user which spin libraries to use, due to inconsistency in the spin libraries mentioned in the below doc links. We believe that we should document the POM content of spin libraries more clearly, like when to use what.

        1. https://docs.camunda.org/manual/latest/user-guide/data-formats/configuring-spin-integration/
        2. https://docs.camunda.org/manual/latest/reference/spin/

        The following things should be clarified:

        * A hint at the implications of what relocating the dependencies like Jackson means in the case of {{camunda-spin-dataformat-all}}
        * A hint when to use which dependency scope {{provided}} vs {{compile}}
        We believe that it could be confusing for an end user which spin libraries to use, due to inconsistency in the spin libraries mentioned in the below doc links. We believe that we should document the POM content of spin libraries more clearly, like when to use what.

        1. https://docs.camunda.org/manual/latest/user-guide/data-formats/configuring-spin-integration/
        2. https://docs.camunda.org/manual/latest/reference/spin/

        The following things should be clarified:

        * A hint at the implications of what relocating the dependencies like Jackson means in the case of {{camunda-spin-dataformat-all}} (e.g. non-shaded Jackson annotations in custom classes will not be picked up)
        * A hint when to use which dependency scope {{provided}} vs {{compile}}
        thorben.lindhauer Thorben Lindhauer made changes -
        Description We believe that it could be confusing for an end user which spin libraries to use, due to inconsistency in the spin libraries mentioned in the below doc links. We believe that we should document the POM content of spin libraries more clearly, like when to use what.

        1. https://docs.camunda.org/manual/latest/user-guide/data-formats/configuring-spin-integration/
        2. https://docs.camunda.org/manual/latest/reference/spin/

        The following things should be clarified:

        * A hint at the implications of what relocating the dependencies like Jackson means in the case of {{camunda-spin-dataformat-all}} (e.g. non-shaded Jackson annotations in custom classes will not be picked up)
        * A hint when to use which dependency scope {{provided}} vs {{compile}}
        We believe that it could be confusing for an end user which spin libraries to use, due to inconsistency in the spin libraries mentioned in the below doc links. We believe that we should document the POM content of spin libraries more clearly, like when to use what.

        1. https://docs.camunda.org/manual/latest/user-guide/data-formats/configuring-spin-integration/
        2. https://docs.camunda.org/manual/latest/reference/spin/

        The following things should be clarified:

        * A hint at the implications of what relocating the dependencies like Jackson means in the case of {{camunda-spin-dataformat-all}} (e.g. non-shaded Jackson annotations in custom classes will not be picked up)
        * A hint when to use which dependency scope ({{provided}} vs {{compile}})
        thorben.lindhauer Thorben Lindhauer made changes -
        Fix Version/s 7.12.0 [ 15387 ]

          People

          • Assignee:
            thorben.lindhauer Thorben Lindhauer
            Reporter:
            garima.yadav Garima Yadav
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:

              Development