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: remove old observability and orchestrate get-started guides #2583

Merged
merged 18 commits into from
Dec 14, 2023

Conversation

StackScribe
Copy link
Contributor

@StackScribe StackScribe commented Nov 27, 2023

Summary

This PR removes two of the old "Getting started" guides - the ones that were listed under "Core Concepts" (previously "Introduction"). Before deleting these, I compared the contents to the other docs and made a couple small changes but really didn't find much in these old guides that we need.

These changes were originally orchestrated under the old docs directory. Those changes were then copied into the docs-new tree with the following exceptions:

  • guides/evaluations.md is significantly modified in PR2639 so was not copied here

Fixes #2505
Fixes #2506

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)

@StackScribe StackScribe added the documentation Improvements or additions to documentation label Nov 27, 2023
@StackScribe StackScribe added this to the 0.10 milestone Nov 27, 2023
@StackScribe StackScribe self-assigned this Nov 27, 2023
@StackScribe StackScribe requested review from a team as code owners November 27, 2023 10:49
Copy link

netlify bot commented Nov 27, 2023

Deploy Preview for keptn-lifecycle-toolkit ready!

Name Link
🔨 Latest commit 48eb54a
🔍 Latest deploy log https://app.netlify.com/sites/keptn-lifecycle-toolkit/deploys/657961495a323b000835b525
😎 Deploy Preview https://deploy-preview-2583--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.

@github-actions github-actions bot added the ops label Nov 28, 2023
Copy link

codecov bot commented Nov 28, 2023

Codecov Report

Merging #2583 (ee8e3fb) into main (601a053) will decrease coverage by 0.11%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2583      +/-   ##
==========================================
- Coverage   85.59%   85.48%   -0.11%     
==========================================
  Files         155      155              
  Lines       10175    10175              
==========================================
- Hits         8709     8698      -11     
- Misses       1190     1198       +8     
- Partials      276      279       +3     

see 3 files with indirect coverage changes

Flag Coverage Δ
certificate-operator 67.43% <ø> (ø)
component-tests 56.36% <ø> (-0.77%) ⬇️
lifecycle-operator 84.44% <ø> (ø)
metrics-operator 87.43% <ø> (ø)
scheduler 36.53% <ø> (ø)

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

Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
Signed-off-by: Meg McRoberts <[email protected]>
docs/content/en/_index.md Outdated Show resolved Hide resolved
docs/content/en/docs/guides/evaluations.md Outdated Show resolved Hide resolved
docs/content/en/_index.md Outdated Show resolved Hide resolved
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]>
@odubajDT
Copy link
Contributor

@StackScribe can you please resolve the conflict? Generally the PR looks good, but with the conflicts we are not able to approve it

Signed-off-by: Moritz Wiesinger <[email protected]>
@mowies mowies removed this from the 0.10 milestone Dec 13, 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.

LGTM, but please move the changes to the docs-new folder

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 9a6dc86 into keptn:main Dec 14, 2023
39 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 ops
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Delete old observability "getting started" Delete old Manage Release Lifecycle "getting started"
4 participants