Uploaded image for project: 'Camunda Optimize'
  1. Camunda Optimize
  2. OPT-2817

Make clear where to find the migration instructions in the docs

    • Icon: Task Task
    • Resolution: Done
    • Icon: L3 - Default L3 - Default
    • 2.7.0
    • None
    • documentation
    • None

      AT:

      • the parent title is rename from Migration & Upgrade to Migration & Upgrade Instructions
      • there is a warning note in each migration notes on where to find the actual migration instructions to emphasize where to find them
      • the subtitle Migrate instruction from 2.1 onwards of the Migration & Upgrade is renamed to Migrations Instructions
      • the changes are backported to all the existing documentation branches up to 2.4
      • the changes have been released so that they are available to our users

      Context:
      Users had troubles to find the right page or the upgrade instructions in general.

        This is the controller panel for Smart Panels app

            [OPT-2817] Make clear where to find the migration instructions in the docs

            Johannes created issue -
            Johannes made changes -
            Summary Original: Make clear where to find the migration instructions New: Make clear where to find the migration instructions in the docs
            Sebastian Bathke made changes -
            Description Original: *AT:*
            * the parent title is rename from {{Migration & Upgrade}} to {{Migration & Upgrade Instructions}}
            * there is a warning note in each migration notes on where to find the actual migration instructions to emphasize where to find them
            * the subtitle {{Migrate instruction from 2.1 onwards}} of the {{Migration & Upgrade}} is renamed to {{Migrations Instructions}}

            *Context:*
            Users had troubles to find the right page or the upgrade instructions in general
            New: *AT:*
            * the parent title is rename from {{Migration & Upgrade}} to {{Migration & Upgrade Instructions}}
            * there is a warning note in each migration notes on where to find the actual migration instructions to emphasize where to find them
            * the subtitle {{Migrate instruction from 2.1 onwards}} of the {{Migration & Upgrade}} is renamed to {{Migrations Instructions}}

            *Context:*
            Users had troubles to find the right page or the upgrade instructions in general
            Sebastian Bathke made changes -
            Description Original: *AT:*
            * the parent title is rename from {{Migration & Upgrade}} to {{Migration & Upgrade Instructions}}
            * there is a warning note in each migration notes on where to find the actual migration instructions to emphasize where to find them
            * the subtitle {{Migrate instruction from 2.1 onwards}} of the {{Migration & Upgrade}} is renamed to {{Migrations Instructions}}

            *Context:*
            Users had troubles to find the right page or the upgrade instructions in general
            New: *AT:*
            * the parent title is rename from {{Migration & Upgrade}} to {{Migration & Upgrade Instructions}}
            * there is a warning note in each migration notes on where to find the actual migration instructions to emphasize where to find them
            * the subtitle {{Migrate instruction from 2.1 onwards}} of the {{Migration & Upgrade}} is renamed to {{Migrations Instructions}}
            * the changes are migrated to all the existing documentation branches

            *Context:*
            Users had troubles to find the right page or the upgrade instructions in general
            Sebastian Bathke made changes -
            Labels Original: current_release New: next_release
            Johannes made changes -
            Labels Original: next_release New: current_release next_release
            Johannes made changes -
            Labels Original: current_release next_release New: current_release
            Johannes made changes -
            Status Original: Open [ 1 ] New: In Specification [ 10000 ]
            Johannes made changes -
            Status Original: In Specification [ 10000 ] New: In Development [ 10312 ]
            Johannes made changes -
            Description Original: *AT:*
            * the parent title is rename from {{Migration & Upgrade}} to {{Migration & Upgrade Instructions}}
            * there is a warning note in each migration notes on where to find the actual migration instructions to emphasize where to find them
            * the subtitle {{Migrate instruction from 2.1 onwards}} of the {{Migration & Upgrade}} is renamed to {{Migrations Instructions}}
            * the changes are migrated to all the existing documentation branches

            *Context:*
            Users had troubles to find the right page or the upgrade instructions in general
            New: *AT:*
            * the parent title is rename from {{Migration & Upgrade}} to {{Migration & Upgrade Instructions}}
            * there is a warning note in each migration notes on where to find the actual migration instructions to emphasize where to find them
            * the subtitle {{Migrate instruction from 2.1 onwards}} of the {{Migration & Upgrade}} is renamed to {{Migrations Instructions}}
            * the changes are backported to all the existing documentation branches up to {{2.4}}
            * the changes have been released so that they are available to our users

            *Context:*
            Users had troubles to find the right page or the upgrade instructions in general.

            We only backport the changes to 2.4. because:
            * the docs directory structure changes with 2.4 and it would be quite some effort to backport the changes to the old structure as well
            * the were only two known customers that used {{2.3}} and even they already upgraded to later versions. Thus, no need to backport the changes to older docs versions as well.

              Unassigned Unassigned
              johannes.heinemann Johannes
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

                Created:
                Updated:
                Resolved: