Skip to content

Add initial contributing docs for operator #1216

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add initial contributing docs for operator #1216

wants to merge 1 commit into from

Conversation

@Fryguy
Copy link
Member

@Fryguy Fryguy commented Feb 27, 2025

@bdunne Please review.

@Fryguy Fryguy requested a review from bdunne as a code owner February 27, 2025 19:00
bdunne
bdunne reviewed Mar 3, 2025
View reviewed changes
manageiq-operator/CONTRIBUTING.md
## Development Setup

### Pre-requisites

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* A recent version of Go

Copy link
Member

Choose a reason for hiding this comment

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

And make

bdunne
bdunne reviewed Mar 3, 2025
View reviewed changes
manageiq-operator/CONTRIBUTING.md
$ WATCH_NAMESPACE=<namespace> make run
```

If you don't already have a ManageIQ CR in the namespace, now you can create one, and the operator will see that and start acting accordingly.
Copy link
Member

Choose a reason for hiding this comment

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

Example: https://github.com/ManageIQ/manageiq-pods/blob/master/manageiq-operator/config/samples/_v1alpha1_manageiq.yaml
For all available options, see: https://github.com/ManageIQ/manageiq-pods/blob/master/manageiq-operator/config/crd/bases/manageiq.org_manageiqs.yaml

bdunne
bdunne reviewed Mar 3, 2025
View reviewed changes
Copy link
Member

@bdunne bdunne left a comment

Choose a reason for hiding this comment

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

Also, we should probably remove duplication from https://github.com/ManageIQ/manageiq-pods/blob/master/manageiq-operator/README.md

@Fryguy
Copy link
Member Author

Fryguy commented Mar 3, 2025

Gah i didn't even realize this was all in the README :(

@miq-bot
Copy link
Member

miq-bot commented Mar 5, 2025

Checked commit Fryguy@c02ba67 with ruby 3.1.5, rubocop 1.56.3, haml-lint 0.51.0, and yamllint
0 files checked, 0 offenses detected
Everything looks fine. 🏆

@miq-bot
Copy link
Member

miq-bot commented Jun 9, 2025

This pull request has been automatically marked as stale because it has not been updated for at least 3 months.

If these changes are still valid, please remove the stale label, make any changes requested by reviewers (if any), and ensure that this issue is being looked at by the assigned/reviewer(s).

@miq-bot miq-bot added the stale label Jun 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bdunne bdunne bdunne left review comments

Assignees

@bdunne bdunne

Labels

documentation stale

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Fryguy @miq-bot @bdunne