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

📖 Fix docs: "Conceptual Guides" section #1473

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

m1kola
Copy link
Member

@m1kola m1kola commented Nov 15, 2024

Description

There were several intentional breaking changes in the API which are now included in v0.18.0 release.

This commit mostly focuses on updating the documentation to reflect API changes. This includes making sure that snippets and example outputs match the current state of the project.

Relevant PRs:

Tip

We also have docs deployment preview. See the comment from netlify bot below.

Tip

Recommend reviewing the changes with git diff --ignore-all-space (-w) option. GitHub UI also has this option.
Screenshot 2024-11-12 at 15 59 15

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

There were several intentional breaking changes in the API
which are now included in v0.18.0 release.

This commit mostly focuses on updating the documentation to
reflect API changes. This includes making sure that snippets
and example outputs match the current state of the project.

Relevant PRs:
* operator-framework#1439
* operator-framework#1434

Signed-off-by: Mikalai Radchuk <[email protected]>
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 15, 2024
Copy link

netlify bot commented Nov 15, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit d9a614d
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/67375d91cdae7000088fcb57
😎 Deploy Preview https://deploy-preview-1473--olmv1.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.

@m1kola m1kola marked this pull request as ready for review November 15, 2024 14:42
@m1kola m1kola requested a review from a team as a code owner November 15, 2024 14:42
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 15, 2024
Copy link

codecov bot commented Nov 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.73%. Comparing base (10e870c) to head (d9a614d).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1473   +/-   ##
=======================================
  Coverage   74.73%   74.73%           
=======================================
  Files          42       42           
  Lines        3241     3241           
=======================================
  Hits         2422     2422           
  Misses        646      646           
  Partials      173      173           
Flag Coverage Δ
e2e 52.32% <ø> (-0.10%) ⬇️
unit 57.17% <ø> (-0.04%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@ankitathomas ankitathomas left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 15, 2024
@m1kola m1kola added this pull request to the merge queue Nov 15, 2024
Merged via the queue into operator-framework:main with commit 39e7dd5 Nov 15, 2024
18 checks passed
@m1kola m1kola deleted the fix_docs branch November 15, 2024 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants