docs(analysis): add missing explanation about failureLimit #1674

huikang · 2021-11-28T05:18:17Z

Signed-off-by: Hui Kang [email protected]

Checklist:

Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this is a chore.
The title of the PR is (a) conventional, (b) states what changed, and (c) suffixes the related issues number. E.g. "fix(controller): Updates such and such. Fixes #1234".
I've signed my commits with DCO
I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
My builds are green. Try syncing with master if they are not.
My organization is added to USERS.md.

Signed-off-by: Hui Kang <[email protected]>

codecov · 2021-11-28T05:27:08Z

Codecov Report

Merging #1674 (4426599) into master (47d59fa) will increase coverage by 0.05%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1674      +/-   ##
==========================================
+ Coverage   81.99%   82.05%   +0.05%     
==========================================
  Files         116      116              
  Lines       15929    16064     +135     
==========================================
+ Hits        13061    13181     +120     
- Misses       2198     2210      +12     
- Partials      670      673       +3

Impacted Files	Coverage Δ
controller/metrics/analysis.go	`87.67% <0.00%> (+0.17%)`	⬆️
analysis/analysis.go	`85.74% <0.00%> (+0.99%)`	⬆️
utils/analysis/helpers.go	`78.18% <0.00%> (+1.18%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 47d59fa...4426599. Read the comment docs.

agrawroh · 2021-12-02T03:22:01Z

docs/features/analysis.md

@@ -520,13 +520,14 @@ spec:
          value: preview-svc.default.svc.cluster.local
 ```

-## Failure Conditions
+## Failure Conditions and Failure Limit


Minor: This could also be shortened as ## Failure Conditions/Limits

agrawroh

                 —— SHIP IT ——

                   ,:',:`,:'
                __||_||_||_||__
           ____["""""""""""""""]____
           \ " '''''''''''''''''''' |
    ~^~~^~^~^^~^~^~^~^~^~^~^~~^~^~^^~~^~^