Skip to content

Commit

Permalink
docs: fixed spacing lints
Browse files Browse the repository at this point in the history
Signed-off-by: tanishkandira <[email protected]>
  • Loading branch information
tanishkandira committed Oct 30, 2024
1 parent 5d544c2 commit 6b2a32c
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions docs/docs/reference/crd-reference/analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,20 +186,20 @@ The overall evaluation has passed, and no warnings have been issued.
}
```

1. **`objectiveResults`**: This is an array containing one or more objects,
1. **`objectiveResults`**: This is an array containing one or more objects,
each representing the results of a specific objective or performance metric.
2. **`result`** -- This object contains information about whether the objective has passed or failed.
2. **`result`** -- This object contains information about whether the objective has passed or failed.
It has two sub-objects **`failResult`** & **`warnResult`**
3. **`failResult`** -- Indicates whether the objective has failed.
3. **`failResult`** -- Indicates whether the objective has failed.
In this case, it checks if a value is greater than 500 milliseconds and it has not been fulfilled (`fulfilled: false`).
4. **`warnResult`** -- Indicates whether the objective has issued a warning.
4. **`warnResult`** -- Indicates whether the objective has issued a warning.
It checks if a value is greater than 300 milliseconds
5. **`warning`** (false in this case).
6. **`pass`** -- Indicates whether the objective has passed (true in this case).
7. **`objective`** -- Describes the objective being evaluated.
5. **`warning`** (false in this case).
6. **`pass`** -- Indicates whether the objective has passed (true in this case).
7. **`objective`** -- Describes the objective being evaluated.
It includes: **`analysisValueTemplateRef`** , **`target`** & **`weight`**
8. **`analysisValueTemplateRef`** -- Refers to the template used for analysis (`response-time-p95`).
9. **`target`** -- Sets the target value for failure (failure occurs if the value is greater than 0).
8. **`analysisValueTemplateRef`** -- Refers to the template used for analysis (`response-time-p95`).
9. **`target`** -- Sets the target value for failure (failure occurs if the value is greater than 0).
In this case, failure occurs
if the value is greater than 500 milliseconds and warning occurs if it's greater than 300 milliseconds.
10. **`weight`** -- Specifies the weight assigned to this objective (weight: 1).
Expand All @@ -220,7 +220,6 @@ The overall evaluation has passed, and no warnings have been issued.
23. **`pass`** -- Indicates whether the overall evaluation has passed (true in this case).
24. **`warning`** -- Indicates whether any warnings have been issued during the evaluation (false in this case).


## Usage

An `Analysis` resource specifies a single Analysis run.
Expand Down

0 comments on commit 6b2a32c

Please sign in to comment.