Skip to content

📖 Fix docs: "How to" section #1463

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

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Conversation

m1kola
Copy link
Member

@m1kola m1kola commented Nov 14, 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:

Reviewer Checklist

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

@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 14, 2024
Copy link

netlify bot commented Nov 14, 2024

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit d32dba2
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/673614ab9dcd950008f41635
😎 Deploy Preview https://deploy-preview-1463--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 force-pushed the fix_docs branch 2 times, most recently from 7bd4e73 to 9ecac97 Compare November 14, 2024 12:23
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]>
@m1kola m1kola marked this pull request as ready for review November 14, 2024 15:26
@m1kola m1kola requested a review from a team as a code owner November 14, 2024 15:26
@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 14, 2024
Copy link
Contributor

@tmshort tmshort left a comment

Choose a reason for hiding this comment

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

/lgtm
Looks like the changes I need to make to some of the tests! :)

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 14, 2024
@tmshort tmshort added this pull request to the merge queue Nov 14, 2024
namespace: argocd
serviceAccount:
name: argocd-installer
version: "!=1.3.2" # Don’t allow version 1.3.2
Copy link
Member Author

Choose a reason for hiding this comment

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

I panicked because of this doc today:

  1. It was using ! instead of !=.
  2. After fixing it - it did not work because of instead of "

I thought we had a regression in version field validation somewhere.

Merged via the queue into operator-framework:main with commit 0931d5b Nov 14, 2024
16 checks passed
@m1kola m1kola deleted the fix_docs branch November 14, 2024 15:45
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