Skip to content

docs: Expand README on OLM operator install#975

Merged
jgwest merged 1 commit into
redhat-developer:masterfrom
olivergondza:update-development-docs
Dec 23, 2025
Merged

docs: Expand README on OLM operator install#975
jgwest merged 1 commit into
redhat-developer:masterfrom
olivergondza:update-development-docs

Conversation

@olivergondza

Copy link
Copy Markdown
Collaborator

What type of PR is this?

Uncomment only one /kind line, and delete the rest.
For example, > /kind bug would simply become: /kind bug

/kind bug
/kind cleanup
/kind failing-test
/kind enhancement
/kind documentation
/kind code-refactoring

What does this PR do / why we need it:

Add details for deploying the operators, troubleshooting steps, etc.

Have you updated the necessary documentation?

  • [no] Documentation update is required by this PR.
  • [YES] Documentation has been updated.

Which issue(s) this PR fixes:

None

Test acceptance criteria:

  • [n/a] Unit Test
  • [n/a] E2E Test

How to test changes / Special notes to the reviewer:

@openshift-ci openshift-ci Bot added the kind/documentation Improvements or additions to documentation label Sep 29, 2025
@openshift-ci

openshift-ci Bot commented Sep 29, 2025

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign jgwest for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Comment thread README.md
image: 'quay.io/<quay-username>/gitops-operator-index:v0.0.1'
publisher: 'Red Hat Developer'
displayName: "!!! GITOPS DEVEL !!!"
image: quay.io/<QUAY_USERNAME>/gitops-operator-catalog:v<VERSION>

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Not sure when this got out of date, but the image is called -catalog now,

Comment thread README.md
Install `opm` binary which is required to build index images

```
make opm

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Dependency of catalog-build, so no to call/document explicitly.

Signed-off-by: Oliver Gondža <ogondza@gmail.com>
@olivergondza olivergondza force-pushed the update-development-docs branch from f97d14f to 1e420e7 Compare October 22, 2025 10:08
@olivergondza

Copy link
Copy Markdown
Collaborator Author

Any comments, objections?

@jgwest jgwest left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@jgwest jgwest merged commit 7a5cfe6 into redhat-developer:master Dec 23, 2025
9 of 10 checks passed
@olivergondza olivergondza deleted the update-development-docs branch December 25, 2025 13:28
aali309 pushed a commit to aali309/gitops-operator that referenced this pull request Jan 29, 2026
Signed-off-by: Oliver Gondža <ogondza@gmail.com>
Signed-off-by: Atif Ali <atali@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants