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: reference page for KeptnTaskDefinition #1083

Closed
wants to merge 77 commits into from
Closed

docs: reference page for KeptnTaskDefinition #1083

wants to merge 77 commits into from

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Mar 22, 2023

Part of #1078 .

This sets up the crd-ref directory and provides a draft of the KeptnTaskDefinition page. This is largely for discussion and PoC although I think this is the beginning of a page that should be completed. It currently has a bit of information I made up and some embedded questions that need to be either answered or removed.

The "CRD Reference Section" title may not be what we want. We discussed having this under Concepts but, with the existing "Concepts" section, this gets messy. So I created this section to be new; we can eventually rename it, although I think having it identified as a Reference section is a good thing.

Note that this PR does not add links from the API Reference pages to these pages. I will do those in a separate PR.

@StackScribe StackScribe added the documentation Improvements or additions to documentation label Mar 22, 2023
@StackScribe StackScribe requested a review from thisthat as a code owner March 22, 2023 03:01
@StackScribe StackScribe self-assigned this Mar 22, 2023
@netlify
Copy link

netlify bot commented Mar 22, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit c8d1daf
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/64264644e9b0810008258866
😎 Deploy Preview https://deploy-preview-1083--keptn-lifecycle-toolkit.netlify.app
📱 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.

Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe StackScribe marked this pull request as draft March 22, 2023 03:16
Signed-off-by: Meg McRoberts <[email protected]>
@mowies mowies changed the title docs: KeptnTaskDefinition yaml crd ref page docs: reference page for KeptnTaskDefinition Mar 22, 2023
@StackScribe StackScribe marked this pull request as ready for review March 27, 2023 01:55
Signed-off-by: Meg McRoberts <[email protected]>
Copy link
Member

@mowies mowies left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments. If you really want to move the auto generated API reference, you also need to adjust all other occurrences of that path in all other files in the project.

docs/content/en/docs/api-ref/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/api-ref/lifecycle/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/crd-ref/TaskDefinition/index.md Outdated Show resolved Hide resolved
docs/content/en/docs/crd-ref/TaskDefinition/index.md Outdated Show resolved Hide resolved
docs/content/en/docs/crd-ref/TaskDefinition/index.md Outdated Show resolved Hide resolved
docs/content/en/docs/crd-ref/TaskDefinition/index.md Outdated Show resolved Hide resolved
docs/content/en/docs/crd-ref/TaskDefinition/index.md Outdated Show resolved Hide resolved
docs/content/en/docs/crd-ref/TaskDefinition/index.md Outdated Show resolved Hide resolved
docs/content/en/docs/crd-ref/TaskDefinition/index.md Outdated Show resolved Hide resolved
docs/content/en/docs/crd-ref/TaskDefinition/index.md Outdated Show resolved Hide resolved
StackScribe and others added 5 commits March 27, 2023 00:58
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
StackScribe and others added 24 commits March 30, 2023 01:41
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts [email protected]

Co-authored-by: Moritz Wiesinger <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
…kit into 0321-task-ref

Signed-off-by: Meg McRoberts [email protected]

Signed-off-by: Meg McRoberts <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Mar 31, 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

@codecov
Copy link

codecov bot commented Mar 31, 2023

Codecov Report

Merging #1083 (c8d1daf) into main (8e93f88) will increase coverage by 20.65%.
The diff coverage is 100.00%.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #1083       +/-   ##
===========================================
+ Coverage   58.88%   79.53%   +20.65%     
===========================================
  Files         126      119        -7     
  Lines       10003     7452     -2551     
===========================================
+ Hits         5890     5927       +37     
+ Misses       3894     1309     -2585     
+ Partials      219      216        -3     
Impacted Files Coverage Δ
...is/lifecycle/v1alpha3/keptntaskdefinition_types.go 100.00% <ø> (ø)
operator/controllers/common/helperfunctions.go 100.00% <ø> (ø)
...ontrollers/common/providers/dynatrace/dynatrace.go 81.66% <100.00%> (+3.66%) ⬆️
...r/apis/lifecycle/v1alpha3/keptnappversion_types.go 97.61% <100.00%> (+0.02%) ⬆️
...perator/apis/lifecycle/v1alpha3/keptntask_types.go 97.59% <100.00%> (+0.12%) ⬆️
.../lifecycle/v1alpha3/keptnworkloadinstance_types.go 95.37% <100.00%> (+0.04%) ⬆️
operator/controllers/common/evaluationhandler.go 77.53% <100.00%> (ø)
operator/controllers/common/taskhandler.go 79.71% <100.00%> (+3.19%) ⬆️
...ator/controllers/lifecycle/interfaces/phaseitem.go 94.82% <100.00%> (ø)
...cle/keptnappversion/reconcile_prepostdeployment.go 81.81% <100.00%> (ø)
... and 6 more

... and 9 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 64.15% <ø> (ø)
component-tests 59.97% <78.57%> (+0.14%) ⬆️
keptn-lifecycle-operator ?
lifecycle-operator 78.52% <96.29%> (+0.12%) ⬆️
metrics-operator 77.57% <100.00%> (+0.22%) ⬆️
scheduler 21.17% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@StackScribe
Copy link
Contributor Author

This PR is superceeded by #1194 , which just modifies doc content/structure and leaves the auto-generated files in the crd-ref directory rather than attempting to move them to the api-directory.

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 ops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants