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: restructure KeptnTaskDefinition, clarify httpRef and functionRef #2138

Merged
merged 24 commits into from
Oct 17, 2023
Merged

docs: restructure KeptnTaskDefinition, clarify httpRef and functionRef #2138

merged 24 commits into from
Oct 17, 2023

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Sep 20, 2023 •
edited

This PR:

  • Clarifies that the httpRef and functionRef syntax can each have a max two functions/resources specified
    • This meant deleting a lot of fanciful text about various ways you could combine KeptnTaskDefinition resources for different needs.
  • Restructures the KeptnTaskDefinition reference page
    • Combine the "Field descriptions" for deno-runtime and python-runtime since the content is almost identical
    • Fix an xref to this page on the migrate/strategy page
    • Replace the code snippets given in the "Field descriptions" with links to the code examples that are included on the page. This makes the page more readable and means that all the examples can be embedded from source code so are easier to maintain.

Closes #2144

@StackScribe
docs: restructure KeptnTaskDefinition, clarify httpRef and functionRef
0027646 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe StackScribe added the documentation Improvements or additions to documentation label Sep 20, 2023
@StackScribe StackScribe added this to the 0.9 milestone Sep 20, 2023
@StackScribe StackScribe requested a review from a team as a code owner September 20, 2023 12:22
@StackScribe StackScribe self-assigned this Sep 20, 2023
@StackScribe StackScribe requested a review from a team as a code owner September 20, 2023 12:22
@netlify
Copy link

netlify bot commented Sep 20, 2023 •
edited

✅ Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 242570e
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/652cf95d9892c80009c18b7c
😎 Deploy Preview https://deploy-preview-2138--keptn-lifecycle-toolkit.netlify.app/docs/yaml-crd-ref/taskdefinition
📱 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 configuration.

@StackScribe
xref in migrate/strategy
1e8e550 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe StackScribe marked this pull request as draft September 20, 2023 22:35
@StackScribe
correct KeptnTaskDefinition descriptions of functionRef and httpRef
c411bcb 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
clarify inline and custom-runner for sequential tasks
51c9aed 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
fix xref
fd26d0a 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
corrected info in sequential task guide
d4bfa18 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
fix xref
9c5902b 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe StackScribe marked this pull request as ready for review September 21, 2023 04:41
@StackScribe
only one httpRef or functionRef line per KeptnTaskDefinition
e054068 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
markdownlint fix
9da1cbe 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
StackScribe and others added 2 commits September 21, 2023 06:31
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/taskdefinition.md
98034e8 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

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

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe @RealAnna
Update docs/content/en/docs/implementing/tasks/_index.md
1c636b0 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: RealAnna <89971034+RealAnna@users.noreply.github.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
odubajDT
odubajDT reviewed Oct 4, 2023
View reviewed changes
docs/content/en/docs/implementing/tasks/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/implementing/tasks/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/implementing/tasks/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/taskdefinition.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/taskdefinition.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/taskdefinition.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/taskdefinition.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/taskdefinition.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/taskdefinition.md Outdated Show resolved Hide resolved
docs/content/en/docs/yaml-crd-ref/taskdefinition.md Outdated Show resolved Hide resolved
StackScribe and others added 6 commits October 4, 2023 16:28
@StackScribe @odubajDT
Update docs/content/en/docs/implementing/tasks/_index.md
2e73799 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe @odubajDT
Update docs/content/en/docs/implementing/tasks/_index.md
dde932d 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

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

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

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

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

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

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@sonarcloud
Copy link

sonarcloud bot commented Oct 4, 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

@StackScribe @odubajDT
Update docs/content/en/docs/implementing/tasks/_index.md
9d7b5ee 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
StackScribe and others added 3 commits October 15, 2023 19:22
@StackScribe @odubajDT
Update docs/content/en/docs/yaml-crd-ref/taskdefinition.md
9301f70 
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: odubajDT <93584209+odubajDT@users.noreply.github.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
xref
72efc74 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
try again
033d693 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe
timeout unit
242570e 
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@sonarcloud
Copy link

sonarcloud bot commented Oct 16, 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

@odubajDT odubajDT merged commit e2c5583 into keptn:main Oct 17, 2023
18 checks passed
@keptn-bot keptn-bot mentioned this pull request Oct 17, 2023
Merged
@StackScribe StackScribe deleted the 0919-fix-taskdefinition branch October 17, 2023 09:58
@keptn-bot keptn-bot mentioned this pull request Jan 23, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bacherfl bacherfl bacherfl approved these changes

@odubajDT odubajDT odubajDT approved these changes

@RealAnna RealAnna Awaiting requested review from RealAnna

Assignees

@StackScribe StackScribe

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.8.3
Development

Successfully merging this pull request may close these issues.

httpRef and functionRef in pre-defined containers can not run multiple executables
4 participants
@StackScribe @bacherfl @RealAnna @odubajDT