Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add usage guide for lvmo [skip ci] #100

Merged
merged 1 commit into from
Feb 16, 2022
Merged

docs: add usage guide for lvmo [skip ci] #100

merged 1 commit into from
Feb 16, 2022

Conversation

leelavg
Copy link
Contributor

@leelavg leelavg commented Feb 2, 2022

Signed-off-by: Leela Venkaiah G [email protected]

@leelavg leelavg changed the title docs: add usage guide for lvmo docs: add usage guide for lvmo [skip ci] Feb 2, 2022
@leelavg leelavg requested a review from nbalacha February 2, 2022 07:00
Copy link

@travisn travisn left a comment

Choose a reason for hiding this comment

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

You might consider breaking this up into multiple docs and have a main doc that links to the others, just a suggestion for a future PR.

sh-4.4# lvs
```

Here LVMO is installed in `lvm-operator-system` namespace via `make deploy`
Copy link

Choose a reason for hiding this comment

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

Instead of make commands, upstream users generally appreciate either kubectl or helm commands for install. The make is just a black box to them. make works well during development, just not for production.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  • ack, this'll be a change in repo readme, you might want to have a look at docs: update readme and documents layout [skip ci] #99 as well 🤔
  • the change more or less translates to push an image to the registry on every release and update yaml manifest for the same like IMG=<pushed-image> make deploy > examples/lvmo.yaml, at best kubectl -f, helm is a stretch atm
  • will take a note of it and update the instructions when we push image to upstream accessible registry

Copy link
Contributor Author

Choose a reason for hiding this comment

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

  • Will be taken up in a separate PR

@leelavg
Copy link
Contributor Author

leelavg commented Feb 3, 2022

You might consider breaking this up into multiple docs and have a main doc that links to the others, just a suggestion for a future PR.

  • ack, the doc/user-guide/index.md is already in place, when the usage guide grows over current file then we'll break it up.
  • below is the index if link changes
# Contents

The user-guide describes alternate installation methods and usage.

1. [Deploy Operator via OLM][alt-deploy]
2. [Alternate Usage][alt-install]

[alt-deploy]: ./alt-deploy.md
[alt-install]: ./alt-install.md

@leelavg leelavg requested review from travisn and nbalacha February 4, 2022 06:52
Copy link

@travisn travisn left a comment

Choose a reason for hiding this comment

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

LGTM!

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 4, 2022
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Feb 10, 2022
Copy link
Contributor

@nbalacha nbalacha left a comment

Choose a reason for hiding this comment

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

Minor comments.

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Feb 16, 2022
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Feb 16, 2022

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: leelavg, nbalacha, travisn

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

The pull request process is described here

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 16, 2022
@nbalacha nbalacha merged commit 1a0aeb9 into openshift:main Feb 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants