-
Task
-
Resolution: Unresolved
-
L3 - Default
-
None
-
None
-
None
-
Not defined
Context:
christian.nicolai raised the point that the way we refer to YAML paths in the installation guide is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P
As an example:
The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090`
would be better as:
A port number that is used by the embedded jetty server to process HTTP connections
YAML-BLOCK-START
container:
ports:
http: 8090
YAML-BLOCK-END
AT:
- all subsections of https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#configuration are adjusted to use fully valid yaml code blocks
This is the controller panel for Smart Panels app
[OPT-2593] Revise inline yaml paths mentioned in installation guide
| Description |
Original:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would use YAML code blocks that are easier to C&P e.g. {{code}} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {{code}} would be better as: {{code}} The following YAML Paths correspond to settings available in the environment configuration: // A port number that is used by the embedded jetty server to process HTTP connections container.ports.http: 8090 {{code}} |
New:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would use YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} The following YAML Paths correspond to settings available in the environment configuration: // A port number that is used by the embedded jetty server to process HTTP connections container.ports.http: 8090 {code} |
| Description |
Original:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would use YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} The following YAML Paths correspond to settings available in the environment configuration: // A port number that is used by the embedded jetty server to process HTTP connections container.ports.http: 8090 {code} |
New:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would use YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK container.ports.http: 8090 YAML-BLOCK {code} |
| Description |
Original:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would use YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK container.ports.http: 8090 YAML-BLOCK {code} |
New:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK container: # A host name or IP address, to identify a specific network interface on # which to listen. host: localhost ports: # A port number that will be used by Optimize to process HTTP connections. # If set to null, ~ or left empty, http connections won't be accepted. http: 8090 # A port number that will be used by Optimize to process # secure HTTPS connections. https: 8091 YAML-BLOCK {code} |
| Description |
Original:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK container: # A host name or IP address, to identify a specific network interface on # which to listen. host: localhost ports: # A port number that will be used by Optimize to process HTTP connections. # If set to null, ~ or left empty, http connections won't be accepted. http: 8090 # A port number that will be used by Optimize to process # secure HTTPS connections. https: 8091 YAML-BLOCK {code} |
New:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK container: ports: # A port number that will be used by Optimize to process HTTP connections. # If set to null, ~ or left empty, http connections won't be accepted. http: 8090 YAML-BLOCK {code} |
| Description |
Original:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK container: ports: # A port number that will be used by Optimize to process HTTP connections. # If set to null, ~ or left empty, http connections won't be accepted. http: 8090 YAML-BLOCK {code} |
New:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK container: ports: http: 8090 YAML-BLOCK {code} |
| Description |
Original:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK container: ports: http: 8090 YAML-BLOCK {code} |
New:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK-START container: ports: http: 8090 YAML-BLOCK-END {code} |
| Description |
Original:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P e.g. {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK-START container: ports: http: 8090 YAML-BLOCK-END {code} |
New:
Context:
[~christian.nicolai] raised the point that the way we refer to YAML paths in the installation [guide|https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#elasticsearch-configuration] is unusual and he would prefer we would provide complete valid YAML code blocks that are easier to C&P As an example: {code} The following YAML Paths correspond to settings available in the environment configuration: container.ports.http - A port number that is used by the embedded jetty server to process HTTP connections Default value: `8090` {code} would be better as: {code} A port number that is used by the embedded jetty server to process HTTP connections YAML-BLOCK-START container: ports: http: 8090 YAML-BLOCK-END {code} AT: - all subsections of https://docs.camunda.org/optimize/latest/technical-guide/setup/installation/#configuration are adjusted to use fully valid yaml code blocks |
| Assignee | Original: Sebastian Bathke [ sebastian.bathke ] | New: Joshua Windels [ joshua.windels ] |
| Labels | New: current_release |