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: rename "tasks" page, delete section from "Tutorials" #2088

Merged
merged 5 commits into from
Sep 29, 2023

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Sep 13, 2023

This PR should be merged after #2089 has been merged, since this PR deletes the tutorials directory and PR2089 moves the other file out of that directory.

This PR:

@StackScribe StackScribe added the documentation Improvements or additions to documentation label Sep 13, 2023
@StackScribe StackScribe added this to the 0.9 milestone Sep 13, 2023
@StackScribe StackScribe self-assigned this Sep 13, 2023
@StackScribe StackScribe requested review from a team as code owners September 13, 2023 04:07
@netlify
Copy link

netlify bot commented Sep 13, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit d85e552
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/6516b455b04d9d0007fe3652
😎 Deploy Preview https://deploy-preview-2088--keptn-lifecycle-toolkit.netlify.app/docs/implementing/tasks
📱 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.

@agardnerIT
Copy link
Contributor

I'm confused. I thought we agreed to implement the tutorials section. This is a new section with the intention that users "flow" from the getting started guide into one of the tutoriuals (probably the pre/post tasks). Also, the tutorials can stand on their own as "quick references" for existing users who need a refresher on "how do I add a pre-evaluation"?

I'm not too precious on the word "tutorials" though if you prefer another descriptor.

@StackScribe
Copy link
Contributor Author

So who was involved in the discussion about adding the Tutorials section? I apologize -- I did not know about this. But I'm not clear how this section would relate to what is in the "Implementing" section -- which I am proposing we rename to be "User Guide". The current content has the information about using Keptn to run tasks for software that is deployed on a VM or something other than k8s, which does not seem like something we would use as just a step up from the "Getting Started Guide.

I am thinking that we need a second "Getting Started" exercise for the Release Lifecycle Management feature -- I think that is the name for it. Basically pre- and post-deployment tasks. So something that has them define some tasks and evaluations, create a simple KeptnApp, annotate it for the pre- and post-deployment tasks. And from there, they should be ready to use the main "User guide" pages, right?

@RealAnna
Copy link
Contributor

@StackScribe and @agardnerIT we just merged this #2121 so the pr will have conflicts now

@StackScribe StackScribe mentioned this pull request Sep 29, 2023
StackScribe and others added 3 commits September 29, 2023 04:25
Signed-off-by: Meg McRoberts [email protected]

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

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

Co-authored-by: odubajDT <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@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
0.0% 0.0% Duplication

@odubajDT odubajDT merged commit 8e5dd76 into keptn:main Sep 29, 2023
14 checks passed
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.

4 participants