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.

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: add Example section to KeptnTask CRD ref #3187

Merged
merged 2 commits into from
Mar 5, 2024
Merged

docs: add Example section to KeptnTask CRD ref #3187

merged 2 commits into from
Mar 5, 2024

Conversation

StackScribe
Copy link
Contributor

Summary

Adds "Example" subsection to KeptnTask CRD reference. This just includes an existing sentence that references the guide chapter but it means that users can use the ref page to quickly locate an example.

Also added link to that guide chapter in the "See also" section.

Fixes # #3178

Checks

  • My PR fulfills the Definition of Done of the corresponding issue and not more (or parts if the issue is separated
    into multiple PRs)
  • I used descriptive commit messages to help reviewers understand my thought process
  • I signed off all my commits according to the Developer Certificate of Origin (DCO)(
    see Contribution Guide)
  • My PR title is formatted according to the semantic PR conventions described in
    the Contribution Guide
  • My content follows the style guidelines of this project (YAMLLint, markdown-lint)
  • I regenerated the auto-generated docs for Helm and the CRD documentation (if applicable)
  • I have performed a self-review of my content including grammar and typo errors and also checked the rendered page
    from the Netlify deploy preview
  • My changes result in all-green PR checks (first-time contributors need to ask a maintainer to approve their test runs)

Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
@StackScribe StackScribe added the documentation Improvements or additions to documentation label Mar 5, 2024
@StackScribe StackScribe added this to the 2.0.0 milestone Mar 5, 2024
@StackScribe StackScribe self-assigned this Mar 5, 2024
@StackScribe StackScribe requested review from a team as code owners March 5, 2024 09:33
Signed-off-by: Meg McRoberts meg.mcroberts@dynatrace.com

Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Copy link

sonarcloud bot commented Mar 5, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@odubajDT odubajDT merged commit 95fdd03 into main Mar 5, 2024
10 checks passed
@odubajDT odubajDT deleted the 0305-task-ex branch March 5, 2024 11:50
bacherfl pushed a commit to bacherfl/lifecycle-controller that referenced this pull request Mar 7, 2024
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: Florian Bacher <florian.bacher@dynatrace.com>
Vickysomtee pushed a commit to Vickysomtee/keptn-lifecycle-toolkit that referenced this pull request Apr 23, 2024
Signed-off-by: Meg McRoberts <meg.mcroberts@dynatrace.com>
Co-authored-by: Moritz Wiesinger <moritz.wiesinger@dynatrace.com>
Signed-off-by: vickysomtee <vickysomtee@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants