search

operator-framework / olm-docs

Hugo doc site for https://github.com/operator-framework/operator-lifecycle-manager
10 stars 82 forks source link

doc: add missing info in the installation guide and olm repo content #122

Closed camilamacedo86 closed 3 years ago

camilamacedo86 commented 3 years ago

Description

Preview: https://deploy-preview-122--operator-lifecycle-manager.netlify.app/docs/getting-started/

Closes: https://github.com/operator-framework/operator-lifecycle-manager/issues/1929

openshift-ci-robot commented 3 years ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: camilamacedo86 To complete the pull request process, please assign ecordell after the PR has been reviewed. You can assign the PR to them by writing /assign @ecordell in a comment when ready.

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

Needs approval from an approver in each of these files: - **[OWNERS](https://github.com/operator-framework/olm-docs/blob/master/OWNERS)** Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
camilamacedo86 commented 3 years ago

H @timflannagan,

all done. Please let me know wdyt? Btw thank you for the help.

timflannagan commented 3 years ago

Awesome, this reads pretty well to me. Thanks!

/lgtm

openshift-ci-robot commented 3 years ago

New changes are detected. LGTM label has been removed.

camilamacedo86 commented 3 years ago

Hi @anik120,

@camilamacedo86 thank you for your PR! Had a few suggestions, and also we can probably get rid of the existing sections "Installing released OLM", "Verify installation". Installing olm with sdk is really cool (with the customization capabilities and everything) and that is what we should be documenting here, not how to install olm from the repo (that's probably the job of the CONTRIBUTING.MD in the repo to document).

I am not sure if it would fit well. See that these instructions are provided for those who want to get started with OLM today not necessarily contribute it but only install the project in their clusters/local envs. I tried to update the docs here with your suggestions and answer the questions. Please, let me know if it is OK now and if as anything else that we should do here.

Also, see that the motivation here is we are able to :

camilamacedo86 commented 3 years ago

HI @anik120 and @hasbro17,

All suggestions/comments are addressed. Could we merge this now for we are able to move forward with https://github.com/operator-framework/operator-lifecycle-manager/pull/2046 and have the link in the readme for OLM docs there as we have for SDK?

camilamacedo86 commented 3 years ago

HI @anik120.

Can we get this one merged now? WDYT?

anik120 commented 3 years ago

@camilamacedo86 in lieu of https://github.com/operator-framework/operator-lifecycle-manager/pull/2046#discussion_r614238234

I think this doc should be simplified to "Installing latest olm with sdk" "Installing released version of olm" (with the installation with sdk coming first) Also, in the Installing latest olm with sdk section, we should probably just copy paste whatever's there in https://sdk.operatorframework.io/docs/olm-integration/quickstart-bundle/#enabling-olm I really like the content of the section, but in that doc it appears backward, i.e the doc is for talking about "olm integration with bundles" but then goes on to say "but wait, if you don't have olm installed, do this first". So this doc can go straight into "install olm with sdk", i.e copy paste of that section

Also, https://sdk.operatorframework.io/docs/olm-integration/quickstart-package-manifests/ seems outdated since we want to move to bundle format instead of packagemanifest format, so we probably need to update https://sdk.operatorframework.io/docs/olm-integration/ soon.

camilamacedo86 commented 3 years ago

Hi @anik120,

Thank you for the reply. Regarding https://github.com/operator-framework/olm-docs/pull/122#issuecomment-820591672.

I am not sure if I follow up on all your ideas. My goal here was more only to add the SDK steps. Would you like to get from here what do you think is good and push a PR with your suggestion? WDYT? Would that be easy?

Also, https://sdk.operatorframework.io/docs/olm-integration/quickstart-package-manifests/ seems outdated since we want to move to bundle format instead of packagemanifest format, so we probably need to update https://sdk.operatorframework.io/docs/olm-integration/ soon.

Yes, you are right. We have a task to fix this section on the SDK side see: https://github.com/operator-framework/operator-sdk/issues/4528

However, here we are not linking this point direct. We just link the section https://sdk.operatorframework.io/docs/olm-integration/ in order to avoid this doc gets outdated. In this way, I think that is fine.

openshift-ci[bot] commented 3 years ago

@camilamacedo86: PR needs rebase.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
camilamacedo86 commented 3 years ago

I am closing this one seems outdated.