Skip to content

📖 Fix docs: "How to" section - #1463

Merged
tmshort merged 1 commit into
operator-framework:mainfrom
m1kola:fix_docs
Nov 14, 2024
Merged

📖 Fix docs: "How to" section#1463
tmshort merged 1 commit into
operator-framework:mainfrom
m1kola:fix_docs

Conversation

@m1kola

@m1kolam1kola commented Nov 14, 2024

Copy link
Copy Markdown
Member

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-ciopenshift-ciBot 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
@netlify

netlifyBot commented Nov 14, 2024

Copy link
Copy Markdown

Deploy Preview for olmv1 ready!

NameLink
🔨 Latest commitd32dba2
🔍 Latest deploy loghttps://app.netlify.com/sites/olmv1/deploys/673614ab9dcd950008f41635
😎 Deploy Previewhttps://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
m1kolaforce-pushed the fix_docs branch 2 times, most recently from 7bd4e73 to 9ecac97CompareNovember 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 <mradchuk@redhat.com>
@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 ownerNovember 14, 2024 15:26
@openshift-ciopenshift-ciBot 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

@tmshorttmshort left a comment

Copy link
Copy Markdown
Contributor

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-ciopenshift-ciBot 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
Copy Markdown
MemberAuthor

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 0931d5bNov 14, 2024
@m1kola
m1kola deleted the fix_docs branch November 14, 2024 15:45
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtmIndicates that a PR is ready to be merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@m1kola@tmshort