docs: migrate to v2 temporal-ui (#952)

* docs: migrate to v2 temporal-ui

* docs: Apply suggestions from code review

Co-authored-by: zhijie-yang <zhijie.yang@canonical.com>

* docs: add server configuration information

* docs: apply header suggestion

Co-authored-by: zhijie-yang <zhijie.yang@canonical.com>

* docs: update run_cmd

* docs: fix run command based on displayed text

* docs: fix error

* docs: homogenize nomenclature

* docs: apply suggestions from review

Updated the documentation for the Temporal UI Docker parameters and run command.

* docs: apply suggestion from review

Co-authored-by: zhijie-yang <zhijie.yang@canonical.com>

---------

Co-authored-by: zhijie-yang <zhijie.yang@canonical.com>

Author: asanvaq

oci/temporal-ui/documentation.yaml

@@ -1,38 +1,48 @@
-version: 1
-
+version: 2
 application: temporal-ui
 description: >
-  The Temporal UI provides a browser-based user interface for Temporal, allowing users to view Workflow Execution state, metadata, and debug their Temporal applications.
-
-docker:
-  parameters:
-    - -p 8081:8081
-  access: |
-    ### New entrypoint `pebble`
-
-    Please note that the entrypoint of the images in this repository is [Pebble](https://documentation.ubuntu.com/pebble/), a lightweight service manager. The pebble process launches and supervises the temporal ui server process.
+  The Temporal UI provides a browser-based user interface for Temporal, allowing users to view Workflow Execution
+  state, metadata, and debug their Temporal applications.
 
-    #### Temporal UI Server Configuration
+  ## Temporal UI Server Configuration
 
-    Temporal UI server must be provided with a configuration file to start up sucessfully. We do not include any default configurations in the image. Instead, we expect the user to either add a configuration file in the deployed container or mount a volume with the config file in the container.
+  Temporal UI server must be provided with a configuration file to start up successfully. We do not include any default configurations in the image. Instead, we expect the user to either add a configuration file in the deployed container or mount a volume with the config file in the container.
 
-    Some development configuration files can be found in [the temporal ui repository](https://github.com/temporalio/ui/tree/main/server/config).
+  Some development configuration files can be found in [the Temporal UI repository](https://github.com/temporalio/ui/tree/main/server/config).
+  
+website: https://github.com/temporalio/ui
+issues: https://github.com/canonical/temporal-rocks/issues
+source-code: https://github.com/canonical/temporal-rocks
 
-    The following outlines steps to mount the development configuration files while launching a container:
-
-    ```sh
-    $ git clone https://github.com/temporalio/ui
-
-    $ docker run -d --name temporal-ui-container -p 8081:8081 -v ./ui/server/config:/home/ui-server/config -e TEMPORAL_ROOT=/home/ui-server -e TEMPORAL_ENVIRONMENT=development ubuntu/temporal-ui:2.39.0-24.04_edge
-    ```
-
-parameters:
-  - type: -e
-    value: 'TEMPORAL_ROOT=/home/ui-server'
-    description: Root directory of execution environment
-  - type: -e
-    value: 'TEMPORAL_CONFIG_DIR=config'
-    description: Config directory path relative to the root
-  - type: -e
-    value: 'TEMPORAL_ENVIRONMENT=development'
-    description: Runtime environment
+docker:
+  parameters: >-
+    -d
+    -p 8081:8081
+    -v <path>:/home/ui-server/config
+    -e TEMPORAL_ROOT=/home/ui-server
+    -e TEMPORAL_ENVIRONMENT=production
+  run_conclusion: |
+    The Temporal UI is started by Pebble and serves the UI on port 8081.
+    
+    To obtain a runnable configuration, refer to the [official repository](https://github.com/temporalio/ui).
+    
+    
+
+config:
+  TEMPORAL_ROOT:
+    type: env
+    description: Root directory of execution environment.
+  TEMPORAL_CONFIG_DIR:
+    type: env
+    description: Config directory path relative to `TEMPORAL_ROOT`.
+  TEMPORAL_ENVIRONMENT:
+    type: env
+    description: Runtime environment.
+  '`-v <path>:/home/ui-server/config`':
+    type: mount
+    description: >-
+      Temporal UI server configuration directory.
+      Replace the target path if `TEMPORAL_ROOT` and `TEMPORAL_CONFIG_DIR` are set to different values from `/home/ui-server` and `config`.
+  '`-p <port>:8081`':
+    type: port
+    description: Temporal UI is configurable to expose the web interface on localhost.