[CAM-13577] Provide consistent documentation of web app configuration via config.js

Type: Bug Report
Resolution: Fixed
Priority: L3 - Default
Fix Version/s: 7.16.0, 7.15.3, 7.16.0-alpha3
Affects Version/s: None
Component/s: documentation, webapp
Labels:
None

Acceptance Criteria (Required on creation):

Web application documentation consistently reflects the new syntax for configuration via config.js based on JavaScript modules
Guides that use the new syntax already:
- https://docs.camunda.org/manual/7.15/webapps/cockpit/extend/configuration/
Guides that need to be updated:
- https://docs.camunda.org/manual/7.15/webapps/admin/configuration/
- https://docs.camunda.org/manual/7.15/webapps/tasklist/configuration/

Hints (Optional):

The migration guide covers the necessary changes for all three web apps correctly already: https://docs.camunda.org/manual/7.15/update/minor/714-to-715/#changes-to-the-webapp-config-files
We need to ensure that the referenced guides are up-to-date with the new approach in general

This is the controller panel for Smart Panels app

Tobias Metzke-Bernstein added a comment - 03/Jun/21 8:15 AM

Decision
We will update our documentation to reflect the new configuration approach in the web apps consistently.
While having a behaviorally backwards-compatible mechanism for web apps configuration would be nice-to-have, we will focus on the new approach to keep the code focused as well.

The migration to the new approach is already documented in the migration guide as a necessary update step.

Tobias Metzke-Bernstein added a comment - 03/Jun/21 8:15 AM Decision We will update our documentation to reflect the new configuration approach in the web apps consistently. While having a behaviorally backwards-compatible mechanism for web apps configuration would be nice-to-have, we will focus on the new approach to keep the code focused as well. The migration to the new approach is already documented in the migration guide as a necessary update step.

Assignee:: Martin Stamm

Reporter:: Miklas Boskamp

DRI:: Martin Stamm

Reviewer:: Tassilo Weidner

Votes:: 0 Vote for this issue

Watchers:: 3 Start watching this issue

Created:: 02/Jun/21 9:12 AM

Updated:: 22/Sep/21 11:28 AM

Resolved:: 09/Jun/21 1:56 PM

Details

Description

Acceptance Criteria (Required on creation):

Hints (Optional):

mgm-controller-panel

This is the controller panel for Smart Panels app

Attachments

Activity

Collapse comment: Tobias Metzke-Bernstein added a comment - 03/Jun/21 8:15 AM

Expand comment: Tobias Metzke-Bernstein added a comment - 03/Jun/21 8:15 AM

People

Dates

Salesforce