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

Improve structure of the Optimize documentation

XMLWordPrintable

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

      AT:

      • the introduction image is updated to the latest version
      • the supported environments sections and the third party library sections are moved to the technical guide
      • in the technical guide there is a subsection "setup" that contains:
        • the installation guide
        • the authorization guide
        • the authentication management
        • configuration
        • secure Elasticsearch
        • history cleanup
      • the links in the following are adjusted accordingly:
        • alert modal
        • optimize-startup.sh
        • optimize-demo.sh
        • optimize-startup.bat
        • optimize-demo.bat
        • logs when configuration is deprecated
      • when ordering an Optimize trial license from camunda.com page, the response email contains a link to the installation guide which should be adjusted as well.
      • the scripts to automatically generated third party library documentations use the right links. You will find the script in the util/dependency-creation module of the Optimize repository
      • the plugin section is not found under import but is its own entry in the technical guide
      • the links to the plugin system in the optimize example repository are updated accordingly
      • link to the configuration when config setting is deprecated is updated
      • there are redirects for latest and master:
        • to point the old configuration link to the new one
        • to point the old installation link to the new one

      Hint:
      For old Optimize versions the links might be broken and therefore we should only make those adjustments for the upcoming versions.

        This is the controller panel for Smart Panels app

            [OPT-1578] Improve structure of the Optimize documentation

            Johannes created issue -
            Johannes made changes -
            Description Original: *AT:*
            * the introduction image is updated to the latest version
            * the supported environments sections and the third party library sections are moved to the technical guide
            * in the technical guide there is a subsection that contains:
            ** the installation guide
            ** the authorization guide
            ** the authentication management
            ** configuration
            ** secure Elasticsearch
            * the links in the following are adjusted accordingly:
            ** alert modal
            ** optimize-startup.sh
            ** optimize-demo.sh
            ** optimize-startup.bat
            ** optimize-demo.bat
            ** logs when configuration is deprecated
            * links in old optimize blog posts that refer to latest/master are adjusted that they refer to a documentation in a specific old version
            * the link in the email to the customers is adjusted to the new structure


            *Hint:*
            For old Optimize versions the links might be broken and therefore we should only make those adjustments for the upcoming versions.             		New: *AT:*
            * the introduction image is updated to the latest version
            * the supported environments sections and the third party library sections are moved to the technical guide
            * in the technical guide there is a subsection that contains:
            ** the installation guide
            ** the authorization guide
            ** the authentication management
            ** configuration
            ** secure Elasticsearch
            * the links in the following are adjusted accordingly:
            ** alert modal
            ** optimize-startup.sh
            ** optimize-demo.sh
            ** optimize-startup.bat
            ** optimize-demo.bat
            ** logs when configuration is deprecated
            * links in old optimize blog posts that refer to latest/master are adjusted that they refer to a documentation in a specific old version
            * the link in the email to the customers is adjusted to the new structure
            * the scripts to automatically generated third party library documentations use the right links. Also the part in the release guide for those scripts are adjusted as well


            *Hint:*
            For old Optimize versions the links might be broken and therefore we should only make those adjustments for the upcoming versions.
            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 -
            Description Original: *AT:*
            * the introduction image is updated to the latest version
            * the supported environments sections and the third party library sections are moved to the technical guide
            * in the technical guide there is a subsection that contains:
            ** the installation guide
            ** the authorization guide
            ** the authentication management
            ** configuration
            ** secure Elasticsearch
            * the links in the following are adjusted accordingly:
            ** alert modal
            ** optimize-startup.sh
            ** optimize-demo.sh
            ** optimize-startup.bat
            ** optimize-demo.bat
            ** logs when configuration is deprecated
            * links in old optimize blog posts that refer to latest/master are adjusted that they refer to a documentation in a specific old version
            * the link in the email to the customers is adjusted to the new structure
            * the scripts to automatically generated third party library documentations use the right links. Also the part in the release guide for those scripts are adjusted as well


            *Hint:*
            For old Optimize versions the links might be broken and therefore we should only make those adjustments for the upcoming versions.             		New: *AT:*
            * the introduction image is updated to the latest version
            * the supported environments sections and the third party library sections are moved to the technical guide
            * in the technical guide there is a subsection "setup" that contains:
            ** the installation guide
            ** the authorization guide
            ** the authentication management
            ** configuration
            ** secure Elasticsearch
            * the links in the following are adjusted accordingly:
            ** alert modal
            ** optimize-startup.sh
            ** optimize-demo.sh
            ** optimize-startup.bat
            ** optimize-demo.bat
            ** logs when configuration is deprecated
            * links in old optimize blog posts that refer to latest/master are adjusted that they refer to a documentation in a specific old version
            * the link in the email to the customers is adjusted to the new structure
            * the scripts to automatically generated third party library documentations use the right links. Also the part in the release guide for those scripts are adjusted as well


            *Hint:*
            For old Optimize versions the links might be broken and therefore we should only make those adjustments for the upcoming versions.
            Johannes made changes -
            Description Original: *AT:*
            * the introduction image is updated to the latest version
            * the supported environments sections and the third party library sections are moved to the technical guide
            * in the technical guide there is a subsection "setup" that contains:
            ** the installation guide
            ** the authorization guide
            ** the authentication management
            ** configuration
            ** secure Elasticsearch
            * the links in the following are adjusted accordingly:
            ** alert modal
            ** optimize-startup.sh
            ** optimize-demo.sh
            ** optimize-startup.bat
            ** optimize-demo.bat
            ** logs when configuration is deprecated
            * links in old optimize blog posts that refer to latest/master are adjusted that they refer to a documentation in a specific old version
            * the link in the email to the customers is adjusted to the new structure
            * the scripts to automatically generated third party library documentations use the right links. Also the part in the release guide for those scripts are adjusted as well


            *Hint:*
            For old Optimize versions the links might be broken and therefore we should only make those adjustments for the upcoming versions.             		New: *AT:*
            * the introduction image is updated to the latest version
            * the supported environments sections and the third party library sections are moved to the technical guide
            * in the technical guide there is a subsection "setup" that contains:
            ** the installation guide
            ** the authorization guide
            ** the authentication management
            ** configuration
            ** secure Elasticsearch
            * the links in the following are adjusted accordingly:
            ** alert modal
            ** optimize-startup.sh
            ** optimize-demo.sh
            ** optimize-startup.bat
            ** optimize-demo.bat
            ** logs when configuration is deprecated
            * links in old optimize blog posts that refer to latest/master are adjusted that they refer to a documentation in a specific old version
            * the link in the email to the customers is adjusted to the new structure
            * the scripts to automatically generated third party library documentations use the right links. Also the part in the release guide for those scripts are adjusted as well
            * the plugin section is not found under import but is its own entry in the technical guide
            * the links to the plugin system in the optimize example repository are updated accordingly


            *Hint:*
            For old Optimize versions the links might be broken and therefore we should only make those adjustments for the upcoming versions.
            Sebastian Bathke made changes -
            Labels Original: current_release New: current_release next_release
            Sebastian Bathke made changes -
            Labels Original: current_release next_release New: next_release
            Sebastian Bathke made changes -
            Labels Original: next_release New: current_release next_release
            Sebastian Bathke made changes -
            Labels Original: current_release next_release New: current_release

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

                Created:
                Updated:
                Resolved: