Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: replace remaining embeds with includes #2941

Merged
merged 2 commits into from
Feb 1, 2024
+13 −4
Merged

docs: replace remaining embeds with includes #2941

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fcd05fa
docs: replace remaining embeds with includes
mowies Feb 1, 2024
7fdde02
use github raw links
mowies Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/docs/guides/slo.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading