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: restructure info on tasks and evaluations #2639

Merged
merged 43 commits into from
Dec 20, 2023

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Dec 6, 2023

Summary

This PR rearranges some information about annotations and pre-/post-deployment tasks

  • Pre- and post- deployment section is removed from the "integrate" page and edited versions are now in the tasks.md and evaluations.md file. I'm not sure I like the amount of duplication but haven't figured out a better solution
  • Info about the pre-/post-deployment annotations is split up between the tasks.md and evaluations.md files and removed from the "Integrate" page.
  • The "evaluations" page now contains a brief reference to "analysis" for people who are looking for more sophisticated investigations than evaluations provide.
  • The "Integrate" page now contains only info about basic annotations and annotations vs labels. I can't come up with a better title for this page but am open to suggestions.
  • Content was originally developed in the old docs source location then copied to the docs-new tree.

Fixes #2497

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)
  • [n/a] 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)

@StackScribe StackScribe added the documentation Improvements or additions to documentation label Dec 6, 2023
@StackScribe StackScribe added this to the 0.10 milestone Dec 6, 2023
@StackScribe StackScribe self-assigned this Dec 6, 2023
@StackScribe StackScribe requested review from a team as code owners December 6, 2023 07:22
@StackScribe StackScribe marked this pull request as draft December 6, 2023 07:22
Copy link

netlify bot commented Dec 6, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 44b2fa5
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/6581591ab2d53e0008bc6d8d
😎 Deploy Preview https://deploy-preview-2639--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 configuration.

Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@StackScribe StackScribe marked this pull request as ready for review December 13, 2023 03:36
StackScribe and others added 3 commits December 13, 2023 19:01
Signed-off-by: Meg McRoberts [email protected]

Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Moritz Wiesinger <[email protected]>
RealAnna
RealAnna previously approved these changes Dec 15, 2023
Copy link
Contributor

@RealAnna RealAnna left a comment

Choose a reason for hiding this comment

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

LGTM we just need to resolve the conflicts 😃

This file was deleted in another PR

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

Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
@github-actions github-actions bot added the ops label Dec 19, 2023
docs-new/docs/components/lifecycle-operator/keptn-apps.md Outdated Show resolved Hide resolved
docs-new/docs/components/lifecycle-operator/keptn-apps.md Outdated Show resolved Hide resolved
docs-new/docs/core-concepts/usecase-orchestrate.md Outdated Show resolved Hide resolved
docs-new/docs/getting-started/lifecycle-management.md Outdated Show resolved Hide resolved
docs-new/docs/getting-started/lifecycle-management.md Outdated Show resolved Hide resolved
docs-new/docs/guides/evaluations.md Outdated Show resolved Hide resolved
docs-new/docs/guides/evaluations.md Outdated Show resolved Hide resolved
docs-new/docs/guides/integrate.md Outdated Show resolved Hide resolved
docs-new/docs/guides/integrate.md Outdated Show resolved Hide resolved
docs/content/en/docs/reference/crd-reference/app.md Outdated Show resolved Hide resolved
StackScribe and others added 10 commits December 19, 2023 01:02
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]

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]>
Signed-off-by: Meg McRoberts [email protected]

Signed-off-by: Meg McRoberts <[email protected]>
docs-new/docs/guides/tasks.md Outdated Show resolved Hide resolved
docs-new/docs/guides/tasks.md Outdated Show resolved Hide resolved
docs-new/docs/guides/tasks.md Outdated Show resolved Hide resolved
docs-new/docs/guides/tasks.md Outdated Show resolved Hide resolved
docs-new/docs/guides/tasks.md Outdated Show resolved Hide resolved
docs-new/docs/guides/tasks.md Outdated Show resolved Hide resolved
docs-new/docs/guides/tasks.md Outdated Show resolved Hide resolved
docs-new/docs/guides/tasks.md Outdated Show resolved Hide resolved
StackScribe and others added 3 commits December 19, 2023 02:38
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]>
Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

StackScribe and others added 5 commits December 19, 2023 02:38
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]>
Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@StackScribe StackScribe merged commit aa1abf0 into keptn:main Dec 20, 2023
38 checks passed
@StackScribe StackScribe deleted the 1201-autoapp branch December 20, 2023 08:13
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.

Update integrate with apps page
3 participants