📖 Update docs monorepo #1612
📖 Update docs monorepo #1612
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
camilamacedo86
force-pushed
the
update-docs-monorepo
branch
2 times, most recently
from
905d0eb to
8dea29f
Compare
camilamacedo86
requested review from
bentito,
joelanford and
LalatenduMohanty
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
camilamacedo86
force-pushed
the
update-docs-monorepo
branch
from
a181084 to
31449ed
Compare
|
|
||
| * 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 |
There was a problem hiding this comment.
Idt this whole line should go away, catd is still needed on the cluster.
There was a problem hiding this comment.
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
|
|
||
| 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 was a problem hiding this comment.
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.
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
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.
openshift-merge-robot
added
the
needs-rebase
- 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
f756713
Compare
openshift-merge-robot
removed
the
needs-rebase
- 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
force-pushed
the
update-docs-monorepo
branch
from
f756713 to
b5e7d00
Compare
|
I am moving forward. We can always pushfollow-ups if we need to do so. |
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