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

Jump to bottom

docs: metrics & evaluation ref and guides #1385

Merged
merged 34 commits into from
May 11, 2023
Merged

docs: metrics & evaluation ref and guides #1385

merged 34 commits into from
May 11, 2023

Conversation

StackScribe
Copy link
Contributor

Replaces #1224

Closes #1080

  • Create reference pages out of the content in the concepts/evaluations file
  • Create reference pages and implementing/metrics out of the content in the concepts/metrics file
  • Move OTel info from metrics to otel page and added a mention of the KeptnConfig CRD for implementing otel
  • Delete the concepts/evaluations, concepts/metrics, and concepts/observe files
  • Update content for 0.8.0 changes

This basically relocates information in the existing documentation into the new structure with a few critical fixes. These pages need additional writing although the new Getting Started Guides will make that work less critical.

Note also that discussions about the new structure are outside this PR. The new structure can and probably will be modified but, for now, we need to make this information available quickly

@StackScribe
docs: metrics & evaluation ref and guides
9bb37ea 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
markdownlint-fix
08bfd59 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe StackScribe requested review from a team as code owners May 6, 2023 05:38
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 6, 2023
@netlify
Copy link

netlify bot commented May 6, 2023 •
edited
Loading

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 4a657d0
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/645ce861400a160008830948
😎 Deploy Preview https://deploy-preview-1385--keptn-lifecycle-toolkit.netlify.app/docs/implementing/evaluatemetrics
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@StackScribe StackScribe mentioned this pull request May 6, 2023
Closed
@StackScribe
fix xref error
4715e98 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
CRD -> resource
9e99cb2 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
odubajDT
odubajDT previously requested changes May 8, 2023
View reviewed changes
docs/content/en/docs/implementing/otel.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metric.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metric.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metricsprovider.md Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metricsprovider.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metricsprovider.md Show resolved Hide resolved
StackScribe and others added 7 commits May 8, 2023 05:16
@StackScribe @odubajDT
Update docs/content/en/docs/implementing/otel.md
ebae390 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/metric.md
2a59a8a 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/metric.md
57406f7 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md
766bfcf 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/evaluationdefinition.md
e23039c 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe
fixes and comments
031d552 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
Merge branch '0505-metric-eval-ref' of github.com:StackScribe/lifecyc…
be97327 
…le-toolkit into 0505-metric-eval-ref

Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com
agardnerIT
agardnerIT previously approved these changes May 10, 2023
View reviewed changes
@StackScribe StackScribe mentioned this pull request May 10, 2023
Closed
aepfli and others added 4 commits May 11, 2023 08:04
@aepfli
fix markdownlink issues
6650c8c 
Signed-off-by: Simon Schrottner <simon.schrottner@dynatrace.com>
@StackScribe
task only executes when evaluation target is met
2847bc6 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
delete "for example" from opening
0e48934 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
Merge branch 'main' into 0505-metric-eval-ref
c17804a
thisthat
thisthat reviewed May 11, 2023
View reviewed changes
docs/content/en/docs/implementing/evaluatemetrics.md Outdated Show resolved Hide resolved
docs/content/en/docs/implementing/evaluatemetrics.md Show resolved Hide resolved
docs/content/en/docs/implementing/otel.md Outdated Show resolved Hide resolved
docs/content/en/docs/implementing/evaluatemetrics.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metric.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metric.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metric.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metric.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metricsprovider.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/metricsprovider.md Outdated Show resolved Hide resolved
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/metric.md
ab2239b 
#1385

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
StackScribe and others added 2 commits May 11, 2023 05:44
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/metric.md
010ab34 
#1385

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @thisthat
Update docs/content/en/docs/implementing/evaluatemetrics.md
cce9681 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
StackScribe and others added 14 commits May 11, 2023 05:47
@StackScribe @thisthat
Update docs/content/en/docs/implementing/otel.md
a954aa9 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @thisthat
Update docs/content/en/docs/implementing/evaluatemetrics.md
db99e21 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @thisthat
Update docs/content/en/docs/yaml-crd-ref/metric.md
d8ecd37 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @thisthat
Update docs/content/en/docs/yaml-crd-ref/metric.md
c778991 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @thisthat
Update docs/content/en/docs/yaml-crd-ref/metric.md
654c717 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @thisthat
Update docs/content/en/docs/yaml-crd-ref/metric.md
9d70f7f 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @thisthat
Update docs/content/en/docs/yaml-crd-ref/metric.md
5113145 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @thisthat
Update docs/content/en/docs/yaml-crd-ref/metricsprovider.md
91945c0 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Giovanni Liva <giovanni.liva@dynatrace.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/metric.md
08e3dd7 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/metric.md
52d248a 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/metricsprovider.md
c8566af 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/metricsprovider.md
c137eab 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <mmcroberts@cloudbees.com>
@StackScribe
Move HPA after kubectl and filtering
76fc320 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
Merge branch '0505-metric-eval-ref' of github.com:StackScribe/lifecyc…
4a657d0 
…le-toolkit into 0505-metric-eval-ref

Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com
@sonarcloud
Copy link

sonarcloud bot commented May 11, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@thisthat thisthat dismissed odubajDT’s stale review May 11, 2023 14:05

comments have been addressed - ready for another round

@thisthat thisthat merged commit 7712bfa into keptn:main May 11, 2023
@keptn-bot keptn-bot mentioned this pull request May 11, 2023
Merged
@keptn-bot keptn-bot mentioned this pull request Jun 26, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RealAnna RealAnna RealAnna left review comments

@odubajDT odubajDT odubajDT approved these changes

@thisthat thisthat thisthat approved these changes

@agardnerIT agardnerIT agardnerIT left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

"Concepts" ref pages for KeptnEvaluation* CRDs
6 participants
@StackScribe @thisthat @agardnerIT @RealAnna @odubajDT @aepfli