:book: Update docs monorepo by camilamacedo86 · Pull Request #1612 · operator-framework/operator-controller

camilamacedo86 · 2025-01-14T12:42:17Z

This PR only move the relevant content from Catalogd README ( quick start and demo ) to the root README centralizing both and update the places where the old catalogd repo was referenced.

Closes: #1339
Closes: #1602

netlify · 2025-01-14T12:42:34Z

✅ Deploy Preview for olmv1 ready!

Name	Link
🔨 Latest commit	`b5e7d00`
🔍 Latest deploy log	https://app.netlify.com/sites/olmv1/deploys/6788f110bd9f2700088628d4
😎 Deploy Preview	https://deploy-preview-1612--olmv1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

camilamacedo86 · 2025-01-14T12:57:10Z

@michaelryanpeter

codecov · 2025-01-14T13:02:03Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.71%. Comparing base (1bbc6cb) to head (b5e7d00).
Report is 7 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #1612 +/- ##
==========================================
+ Coverage 66.69% 66.71% +0.02% 
==========================================
Files 57 57 Lines 4588 4588 ==========================================
+ Hits 3060 3061 +1 + Misses 1303 1302 -1 
Partials 225 225

Flag	Coverage Δ
e2e	`52.66% <ø> (-0.09%)`	⬇️
unit	`53.66% <ø> (+0.02%)`	⬆️

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.

bentito · 2025-01-15T14:29:20Z


 * Access to a Kubernetes cluster, for example `kind`, using an account with `cluster-admin` permissions
 * [Operator Controller installed](https://github.com/operator-framework/operator-controller/releases) on the cluster
-* [Catalogd installed](https://github.com/operator-framework/catalogd/releases/) on the cluster


Idt this whole line should go away, catd is still needed on the cluster.

We have 1 project now.
The release of https://github.com/operator-framework/operator-controller/releases will end up a file with both projects. So, I updated it for
Operator Controller and Catalogd installed on the cluster

makon57

Looks good, just left some comments nothing that needs serious change. Things to note is just consistency in how we reference things but looks like everything that needs change for catalogs repo was done.

makon57 · 2025-01-15T17:53:20Z

@@ -15,10 +15,10 @@ Thank you for your interest in contributing to the Operator-Controller.

 As you may or may not know, the Operator-Controller project aims to deliver the user experience described in the [Operator Lifecycle Manager (OLM) V1 Product Requirements Document (PRD)](https://docs.google.com/document/d/1-vsZ2dAODNfoHb7Nf0fbYeKDF7DUqEzS9HqgeMCvbDs/edit). The design requirements captured in the OLM V1 PRD were born from customer and community feedback based on the experience they had with the released version of [OLM V0](https://github.com/operator-framework/operator-lifecycle-manager).


There are inconsistencies in how we reference OLM v1/V1 or v0/V0? Maybe stick to lowercase (OLM v1 & OLM v0) as that is the case with all the other docs.

Hi @makon57,
Thank you for pointing this out—you’re absolutely right!
However, I think this might go beyond the scope of this PR.
What do you think about raising a separate PR to ensure we describe it consistently across all relevant places?
Would you like to work on that? It would be great to have your contribution to this!

Agreed. While there are definitely updates that need to be made (for e.g. AFAIK the whole PRD needs an update) the scope of this PR is pretty focused on the monorepo reorganization.
Would absolutely welcome a PR (or more) to address other issues.

- Replaced references to https://github.com/operator-framework/catalogd/ across the documentation. - Ensures that all mentions of the old catalogd repository are correctly updated.

- Integrated relevant content from catalogd/README.md into the project's main README by adding Demo and Quick-Start steps from catalogd/README.md to the main README. - Removed the old catalogd/README.md as its remaining content (e.g., contribution guidelines) is already covered in CONTRIBUTING.md.

Co-authored-by: Jordan Keister Co-authored-by: Per Goncalves da Silva <perdasilva@redhat.com>

…now we have only one service Co-authored-by: Brett Tofel <btofel@redhat.com>

- Update catalogd/docs/fetching-catalog-contents.md - Updare docs/tutorials/add-catalog.md

camilamacedo86 · 2025-01-17T14:00:41Z

I am moving forward. We can always pushfollow-ups if we need to do so.

camilamacedo86 requested a review from a team as a code owner January 14, 2025 12:42

camilamacedo86 force-pushed the update-docs-monorepo branch 2 times, most recently from 905d0eb to 8dea29fCompare January 14, 2025 12:51

camilamacedo86 requested review from LalatenduMohanty, bentito and joelanford January 14, 2025 12:56

perdasilva reviewed Jan 14, 2025
View reviewed changes

Comment threadCONTRIBUTING.md Outdated

perdasilva reviewed Jan 14, 2025
View reviewed changes

Comment threadCONTRIBUTING.md Outdated

perdasilva reviewed Jan 14, 2025
View reviewed changes

Comment threadCONTRIBUTING.md Outdated

camilamacedo86 force-pushed the update-docs-monorepo branch from a181084 to 31449edCompare January 14, 2025 20:21

camilamacedo86 requested review from michaelryanpeter and perdasilva January 14, 2025 20:21

bentito reviewed Jan 15, 2025
View reviewed changes

Comment threaddocs/contribute/developer.md Outdated

bentito reviewed Jan 15, 2025
View reviewed changes

grokspawn reviewed Jan 15, 2025
View reviewed changes

Comment threadCONTRIBUTING.md Outdated

grokspawn reviewed Jan 15, 2025
View reviewed changes

Comment threadCONTRIBUTING.md Outdated

grokspawn reviewed Jan 15, 2025
View reviewed changes

Comment threadREADME.md Outdated

grokspawn reviewed Jan 15, 2025
View reviewed changes

Comment threadREADME.md Outdated

makon57 reviewed Jan 15, 2025
View reviewed changes

openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 16, 2025

[Monorepo] Update documentation for old catalogd repository references
a2c9a63
- Replaced references to https://github.com/operator-framework/catalogd/ across the documentation. - Ensures that all mentions of the old catalogd repository are correctly updated.

camilamacedo86 force-pushed the update-docs-monorepo branch from 390786f to f756713Compare January 16, 2025 11:30

openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 16, 2025

camilamacedo86and others added 4 commits January 16, 2025 11:42

[Monorepo] enhancements and ajustments in the contributing guide
6782449
Co-authored-by: Jordan Keister Co-authored-by: Per Goncalves da Silva <perdasilva@redhat.com>

[Monorepo] Update docs/contribute/developer.md : Fix Tilt info since …
6cbb8b8
…now we have only one service Co-authored-by: Brett Tofel <btofel@redhat.com>

[Monorepo] Small fixes in the docs and tutorials regards the changes
b5e7d00
- Update catalogd/docs/fetching-catalog-contents.md - Updare docs/tutorials/add-catalog.md

camilamacedo86 force-pushed the update-docs-monorepo branch from f756713 to b5e7d00Compare January 16, 2025 11:44

camilamacedo86 requested review from bentito, grokspawn and makon57 January 16, 2025 11:46

grokspawn approved these changes Jan 17, 2025
View reviewed changes

camilamacedo86 added this pull request to the merge queue Jan 17, 2025

Merged via the queue into operator-framework:main with commit f8206bfJan 17, 2025

camilamacedo86 deleted the update-docs-monorepo branch January 17, 2025 18:09

		@@ -15,10 +15,10 @@ Thank you for your interest in contributing to the Operator-Controller.

		As you may or may not know, the Operator-Controller project aims to deliver the user experience described in the [Operator Lifecycle Manager (OLM) V1 Product Requirements Document (PRD)](https://docs.google.com/document/d/1-vsZ2dAODNfoHb7Nf0fbYeKDF7DUqEzS9HqgeMCvbDs/edit). The design requirements captured in the OLM V1 PRD were born from customer and community feedback based on the experience they had with the released version of [OLM V0](https://github.com/operator-framework/operator-lifecycle-manager).

Uh oh!

Conversation

camilamacedo86 commented Jan 14, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlifyBot commented Jan 14, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for olmv1 ready!

Uh oh!

camilamacedo86 commented Jan 14, 2025

Uh oh!

codecovBot commented Jan 14, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bentitoJan 15, 2025

Choose a reason for hiding this comment

Uh oh!

camilamacedo86Jan 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

makon57 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

makon57Jan 15, 2025

Choose a reason for hiding this comment

Uh oh!

camilamacedo86Jan 16, 2025

Choose a reason for hiding this comment

Uh oh!

grokspawnJan 17, 2025

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 commented Jan 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

camilamacedo86 commented Jan 14, 2025•
edited
Loading

netlifyBot commented Jan 14, 2025•
edited
Loading

codecovBot commented Jan 14, 2025•
edited
Loading