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

Improve documentation regarding POM content of SPIN libraries

      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)

        This is the controller panel for Smart Panels app

            [CAM-10584] Improve documentation regarding POM content of SPIN libraries

            Garima Yadav created issue -
            Garima Yadav made changes -
            Link New: This issue is related to SUPPORT-6016 [ SUPPORT-6016 ]
            Tassilo Weidner made changes -
            Status Original: Open [ 1 ] New: Ready [ 10005 ]
            Garima Yadav made changes -
            Assignee New: Thorben Lindhauer [ thorben.lindhauer ]
            Thorben Lindhauer made changes -
            Description Original: 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/

            New: 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 made changes -
            Description Original: 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}}
            New: 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 made changes -
            Description Original: 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}}
            New: 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 made changes -
            Fix Version/s New: 7.12.0 [ 15387 ]
            Thorben Lindhauer made changes -
            Status Original: Ready [ 10005 ] New: In Progress [ 3 ]
            Thorben Lindhauer made changes -
            Assignee Original: Thorben Lindhauer [ thorben.lindhauer ] New: Tobias Metzke-Bernstein [ tobias.metzke ]
            Resolution New: Fixed [ 1 ]
            Status Original: In Progress [ 3 ] New: Resolved [ 5 ]
            Remaining Estimate New: 0 minutes [ 0 ]
            Original Estimate New: 0 minutes [ 0 ]

              Unassigned Unassigned
              garima.yadav Garima Yadav
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: