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 #1194

Closed
wants to merge 65 commits into from
Closed

docs: reference page for KeptnTaskDefinition #1194

wants to merge 65 commits into from

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Apr 7, 2023

This PR moves existing information about tasks into the new structure. Additional work is required for all this material but this is a first step. Specifics:

  • Moves the info in the concepts/task page to the KeptnTaskDefinition ref page
    • Big sections about secrets and context are still on this page but I think each of them should be discussed on their own page in "Implementing" -- merge with info that is currently in the "Working with tasks" page
  • Deletes the concepts/task file
  • Moves the tasks/write-tasks file into integrating/task.md
    • Delete material that absolutely duplicates what is in the KeptnTaskDefinition ref page
    • Did a quick rewrite of what was left, basically "Parameterizing functions" and "Using secrets"
    • The KeptnTaskDefinition ref page also has some info about parameters and secrets. I think all the "secrets" information needs to be pulled into its own page in the "Implementing..." section

This PR supercedes #1083, which also attempted to move the autogenerated files from the crd-ref directory to api-ref.

@StackScribe StackScribe self-assigned this Apr 7, 2023
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 7, 2023
@StackScribe StackScribe marked this pull request as draft April 7, 2023 05:24
@netlify
Copy link

netlify bot commented Apr 7, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit fc3bc33
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/644c5e61dc26de0008cd465d
😎 Deploy Preview https://deploy-preview-1194--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.

@StackScribe StackScribe marked this pull request as ready for review April 11, 2023 08:34
Signed-off-by: Meg McRoberts <[email protected]>
…e-toolkit into 0406-taskdefinition

Signed-off-by: Meg McRoberts [email protected]
Signed-off-by: Meg McRoberts [email protected]
@codecov
Copy link

codecov bot commented Apr 24, 2023

Codecov Report

Merging #1194 (d11b797) into main (2261a4a) will decrease coverage by 0.42%.
The diff coverage is n/a.

❗ Current head d11b797 differs from pull request most recent head fc3bc33. Consider uploading reports for the commit fc3bc33 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1194      +/-   ##
==========================================
- Coverage   59.76%   59.35%   -0.42%     
==========================================
  Files         138      137       -1     
  Lines       10444    10267     -177     
==========================================
- Hits         6242     6094     -148     
+ Misses       3967     3948      -19     
+ Partials      235      225      -10     

see 10 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 64.15% <ø> (ø)
component-tests 60.57% <ø> (+0.26%) ⬆️
lifecycle-operator 78.03% <ø> (-0.25%) ⬇️
metrics-operator 77.80% <ø> (ø)
scheduler 21.75% <ø> (ø)

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

@StackScribe StackScribe requested review from a team as code owners April 24, 2023 10:14
@mowies mowies changed the title docs: add content to KeptnTaskDefinition ref page docs: reference page for KeptnTaskDefinition Apr 25, 2023
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.

this PR has changes in far more files than the task definition. i think those changes don't belong in this PR but in #1224 right?

@StackScribe
Copy link
Contributor Author

About all those files that don't belong in the PR... Between rebases and markdownlint -fix, files got pulled in here that don't belong. I think the same files are in PR1224 -- I have no idea how things got so messed up!

@mowies
Copy link
Member

mowies commented Apr 26, 2023

@StackScribe please either revert the changes that don't belong here via git or manually by copying over the original content

@sonarqubecloud
Copy link

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
Copy link
Contributor Author

This PR is corrupted and so I am deleting it. It is replaced by #1392 .

@StackScribe StackScribe closed this May 9, 2023
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