📖 update general/product documentation #1135
Conversation
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
perdasilva
force-pushed
the
perdasilva/docs/general
branch
from
3bbbf63
to
5c50cc1
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1135 +/- ##
=======================================
Coverage 75.44% 75.44%
=======================================
Files 35 35
Lines 1918 1918
=======================================
Hits 1447 1447
Misses 329 329
Partials 142 142
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
perdasilva
force-pushed
the
perdasilva/docs/general
branch
from
5c50cc1
to
5368f74
Compare
perdasilva
added
documentation
docs/index.md
Outdated
|
|
||
| In the dependency model, extensions can rely on each other for required services that are out of scope of the primary purpose of an extension, allowing each extension to focus on a specific purpose. | ||
| * get installed, potentially causing other dependency extensions to be installed as well |
There was a problem hiding this comment.
I was under the impression that we are not doing any dependency resolution as part of OLM 1.0.
There was a problem hiding this comment.
I don't think it's our highest priority, but, I also don't think it's been completely ruled out ^^ (I'm sure PM really wants it XD)
perdasilva
force-pushed
the
perdasilva/docs/general
branch
from
4111ff7
to
f59ad46
Compare
|
@adellape thank you, Alex!!! |
Signed-off-by: Per Goncalves da Silva <pegoncal@redhat.com>
perdasilva
force-pushed
the
perdasilva/docs/general
branch
from
f59ad46
to
64e7ba9
Compare
docs/index.md
Outdated
| OLM (v0) has been in production for over 5 years, and the community to leverage this experience and question the initial | ||
| goals and assumptions of the project. OLM v1 is a complete redesign and rewrite of OLM taking into account this accumulated experience. |
| Compared to its predecessor, amongst other things, OLM v1 aims to provide: | ||
| * A simpler API surface and mental model | ||
| * Less opinionated automation and greater flexibility | ||
| * Support for Kubernetes applications beyond only Operators | ||
| * Security by default | ||
| * Helm Chart support | ||
| * GitOps support |
There was a problem hiding this comment.
This might be better dealt with in a follow up issue, but I feel like we are burying the lead here.
I think it might be better to lead with what OLM v1 is, and make this block the second paragraph (line 8). Then we can go into the history of OLM v0 and the differences in scope.
If that is too much of a pivot, I'd be up for tweaking this in a follow up issue/PR.
There was a problem hiding this comment.
Yeah, let's push that effort to a different PR. It should mostly be rejiggering order, I'd say.
Co-authored-by: Michael Peter <mipeter@redhat.com>
Co-authored-by: Michael Peter <mipeter@redhat.com>
Co-authored-by: Michael Peter <mipeter@redhat.com>
Co-authored-by: Alex Dellapenta <adellape@redhat.com>
Co-authored-by: Michael Peter <mipeter@redhat.com>
Co-authored-by: Michael Peter <mipeter@redhat.com>
|
LGTM. |
Closes #1122
Reviewer Checklist