docs: last minute polish (keptn#2988)

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: vickysomtee <[email protected]>

docs/docs/guides/otel.md

@@ -166,7 +166,8 @@ You can access the metrics from your browser at: `http://localhost:9999`
 In Keptn you can connect multiple traces, for instance to connect deployments
 of the same application through different stages.
 To create connections between the traces of versions of your application, you can enrich the
-`KeptnAppContext` resource with
+[KeptnAppContext](../reference/crd-reference/appcontext.md)
+resource with
 [OpenTelemetry span links](https://opentelemetry.io/docs/concepts/signals/traces/#span-links).
 You can retrieve the span link from the JSON representation of the trace in Jaeger, where
 it has the following structure:
@@ -184,8 +185,9 @@ to connect traces of different versions of the application.
 ```
 
 > **Note**
-> Please be aware that the span link is just an example, and you need to retrieve the traceID and spanID
-> of the application trace stored in the `KeptnAppVersion` resource you want to link.
+> The span link used above is just an example.
+> You need to replace it with the traceID and spanID
+> that you retrieve from the `KeptnAppVersion` resource you want to link.
 
 To store this new information in the traces, you need to increment the version
 of your application and apply the`KeptnAppContext`.

docs/docs/reference/crd-reference/appcontext.md

@@ -72,16 +72,16 @@ spec:
           ```
 
        For more information, see
-       [Advanced tracing configurations in Keptn Linking traces](../../guides/otel.md#advanced-tracing-configurations-in-keptn-linking-traces)
+       [Context metadata](../../guides/metadata.md).
 
      - **spanLinks** -- List of OpenTelemetry span links
-    that connect multiple traces.
-    For example, this can be used to connect
-    deployments of the same application
-    through different stages.
-    You can retrieve the value to use
-    from the JSON representation of the trace in Jaeger.
-    The structure of this is:
+       that connect multiple traces.
+       For example, this can be used to connect
+       deployments of the same application
+       through different stages.
+       You can retrieve the value to use
+       from the JSON representation of the trace in Jaeger.
+       The structure of this is:
 
           ```yaml
           00-<trace-id>-<span-id>-01
@@ -92,6 +92,9 @@ spec:
           of the corresponding `KeptnApp` resource
           and apply the manifest to store the information in the traces.
 
+          For more information, see
+          [Advanced tracing configurations in Keptn Linking traces](../../guides/otel.md#advanced-tracing-configurations-in-keptn-linking-traces)
+
 The remaining fields are required only when implementing
 the release lifecycle management feature.
 If used, these fields must be populated manually:
@@ -171,4 +174,5 @@ of the lifecycle operator.
   [Release Lifecycle Management](../../getting-started/lifecycle-management.md)
 - [Use Keptn automatic app discovery](../../guides/auto-app-discovery.md)
 - [Restart an Application Deployment](../../guides/restart-application-deployment.md)
+- [Context metadata](../../guides/metadata.md)
 - [Advanced tracing configurations in Keptn Linking traces](../../guides/otel.md#advanced-tracing-configurations-in-keptn-linking-traces)

docs/docs/reference/crd-reference/taskdefinition.md

@@ -73,49 +73,51 @@ spec:
 ```
 
 ### Fields used for all containers
+<!-- markdownlint-disable MD007 -->
 
 * **apiVersion** -- API version being used.
 `
 * **kind** -- Resource type.
    Must be set to `KeptnTaskDefinition`
 
 * **metadata**
-  * **name** -- Unique name of this task or container.
-    This is the name used to insert this task or container
-    into the `preDeployment` or `postDeployment` list.
-    Names must comply with the
-    [Kubernetes Object Names and IDs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names)
-    specification.
+     * **name** -- Unique name of this task or container.
+       This is the name used to insert this task or container
+       into the `preDeployment` or `postDeployment` list.
+       Names must comply with the
+       [Kubernetes Object Names and IDs](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-subdomain-names)
+       specification.
 * **spec**
-  * **deno | python | container** (required) -- Define the container type
-  to use for this task.
-  Each task can use one type of runner,
-  identified by this field:
-    * **deno** -- Use a `deno-runtime` runner
-    and code the functionality in Deno script,
-    which is similar to JavaScript and Typescript.
-    See
-    [Synopsis for deno-runtime container](#deno-runtime)
-    * **python** -- Use a `python-runtime` function
-    and code the functionality in Python 3.
-    See
-    [Synopsis for python-runtime runner](#python-runtime)
-    * **container** -- Use the runner defined
-      for the `container-runtime` container.
-      This is a standard Kubernetes container
-      for which you define the image, runner, runtime parameters, etc.
-      and code the functionality to match the container you define.
-      See
-      [Synopsis for container-runtime container](#synopsis-for-container-runtime).
-  * **retries** -- specifies the number of times
-    a job executing the `KeptnTaskDefinition`
-    should be restarted if an attempt is unsuccessful.
-  * **timeout** -- specifies the maximum time
-    to wait for the task to be completed successfully.
-    The value supplied should specify the unit of measurement;
-    for example, `5s` indicates 5 seconds and `5m` indicates 5 minutes.
-    If the task does not complete successfully within this time frame,
-    it is considered to be failed.
+     * **deno | python | container** (required) -- Define the container type
+       to use for this task.
+       Each task can use one type of runner,
+       identified by this field:
+
+          * **deno** -- Use a `deno-runtime` runner
+            and code the functionality in Deno script,
+            which is similar to JavaScript and Typescript.
+            See
+            [Synopsis for deno-runtime container](#deno-runtime)
+          * **python** -- Use a `python-runtime` function
+            and code the functionality in Python 3.
+            See
+            [Synopsis for python-runtime runner](#python-runtime)
+          * **container** -- Use the runner defined
+            for the `container-runtime` container.
+            This is a standard Kubernetes container
+            for which you define the image, runner, runtime parameters, etc.
+            and code the functionality to match the container you define.
+            See
+            [Synopsis for container-runtime container](#synopsis-for-container-runtime).
+     * **retries** -- specifies the number of times
+       a job executing the `KeptnTaskDefinition`
+       should be restarted if an attempt is unsuccessful.
+     * **timeout** -- specifies the maximum time
+       to wait for the task to be completed successfully.
+       The value supplied should specify the unit of measurement;
+       for example, `5s` indicates 5 seconds and `5m` indicates 5 minutes.
+       If the task does not complete successfully within this time frame,
+       it is considered to be failed.
 
 ## Synopsis for container-runtime
 
@@ -329,6 +331,7 @@ spec:
       [Example 3: functionRef for a Deno script](#example-3-functionref-for-a-deno-script)
     * **python example:**
       [Example 3: functionRef for a python-runner runner](#example-3-functionref-for-a-python-runtime-runner)
+<!-- markdownlint-enable MD007 -->
 
 ## Usage
 

mkdocs.yml

@@ -120,7 +120,7 @@ nav:
           - Evaluations: docs/guides/evaluations.md
           - DORA metrics: docs/guides/dora.md
           - OpenTelemetry observability: docs/guides/otel.md
-          - Metadata: docs/guides/metadata.md
+          - Context metadata: docs/guides/metadata.md
       - Use Cases:
           - docs/use-cases/index.md
           - Day 2 Operations: docs/use-cases/day-2-operations.md