Skip to content

Commit

Permalink
docs: replace remaining embeds with includes (#2941)
Browse files Browse the repository at this point in the history
Signed-off-by: Moritz Wiesinger <[email protected]>
  • Loading branch information
mowies authored Feb 1, 2024
1 parent 6f75f51 commit ff45589
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
13 changes: 10 additions & 3 deletions docs/docs/guides/slo.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,9 @@ A Keptn Analysis is implemented with three resources:

Consider the following `Analysis` resource:

{{< embed path="/metrics-operator/config/samples/metrics_v1beta1_analysis.yaml" >}}
```yaml
{% include "https://raw.githubusercontent.com/keptn/lifecycle-toolkit/main/metrics-operator/config/samples/metrics_v1beta1_analysis.yaml" %}
```

This `Analysis` resource:

Expand All @@ -107,7 +109,9 @@ This `Analysis` resource:
The `AnalysisDefinition` resource references this `Analysis` resource
by its `name` and `namespace` and can be seen here:

{{< embed path="/metrics-operator/config/samples/metrics_v1beta1_analysisdefinition.yaml" >}}
```yaml
{% include "https://raw.githubusercontent.com/keptn/lifecycle-toolkit/main/metrics-operator/config/samples/metrics_v1beta1_analysisdefinition.yaml" %}
```

This simple definition contains a single objective, `response-time-p95`.
For this objective, both failure and warning criteria are defined:
Expand All @@ -130,7 +134,10 @@ this means that the analysis either passes with 100%
or fails with 0% (slower response time).

The objective points to the corresponding `AnalysisValueTemplate` resource:
{{< embed path="/metrics-operator/config/samples/metrics_v1beta1_analysisvaluetemplate.yaml" >}}

```yaml
{% include "https://raw.githubusercontent.com/keptn/lifecycle-toolkit/main/metrics-operator/config/samples/metrics_v1beta1_analysisvaluetemplate.yaml" %}
```

This template defines a query to a provider called `prometheus`:

Expand Down
4 changes: 3 additions & 1 deletion docs/docs/reference/crd-reference/analysisdefinition.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,9 @@ Each of these objectives must specify:

## Example

{{< embed path="/metrics-operator/config/samples/metrics_v1beta1_analysisdefinition.yaml" >}}
```yaml
{% include "https://raw.githubusercontent.com/keptn/lifecycle-toolkit/main/metrics-operator/config/samples/metrics_v1beta1_analysisdefinition.yaml" %}
```

For a full example of how to implement the Keptn Analysis feature, see the
[Analysis](../../guides/slo.md)
Expand Down

0 comments on commit ff45589

Please sign in to comment.