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

📖 Update optional fields in docs for Machine and Cluster controllers #7328

Merged
merged 1 commit into from
Oct 23, 2022

Conversation

Jont828
Copy link
Contributor

@Jont828 Jont828 commented Sep 30, 2022

What this PR does / why we need it: Update optional fields in docs for Machine and Cluster controllers
Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #7300 #7301

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 30, 2022
@oscr
Copy link
Contributor

oscr commented Oct 1, 2022

/lgtm

Content looks accurate based on the code.

Not related to this pr but a general question. How detailed should the documentation be? When it becomes this detailed it's getting very close to just reading the code or the godoc. Comparing:

FailureDomainSpec` is defined as:
- `controlPlane` (bool): indicates if failure domain is appropriate for running control plane instances.
- `attributes` (`map[string]string`): arbitrary attributes for users to apply to a failure domain.

with https://pkg.go.dev/sigs.k8s.io/[email protected]/api/v1alpha4#FailureDomainSpec

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 1, 2022
Copy link
Contributor

@killianmuldoon killianmuldoon left a comment

Choose a reason for hiding this comment

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

/lgtm

IMO having these definitions be close to the godoc isn't necessarily a bad thing as the godoc isn't a great source of information for the contract definition.

I think these pages are close to the source of truth for the reality of the provider contracts, so having field information that's close to the level of detail of the godoc isn't IMO an issue.

@fabriziopandini
Copy link
Member

/lgtm
@sbueringer PTAL

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 6, 2022
Copy link
Member

@sbueringer sbueringer left a comment

Choose a reason for hiding this comment

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

Sorry, last nits from my side. Just noticed that the current definition of addresses are not entirely correct

@oscr
Copy link
Contributor

oscr commented Oct 17, 2022

@Jont828 Could you please also squash your commits? If you don't know how it's described in CONTRIBUTING

@Jont828
Copy link
Contributor Author

Jont828 commented Oct 21, 2022

@oscr Done, let me know if there's anything else I need to do to get this merged!

@sbueringer
Copy link
Member

Thank you very much!

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 23, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sbueringer

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 23, 2022
@k8s-ci-robot k8s-ci-robot merged commit d8862e7 into kubernetes-sigs:main Oct 23, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.3 milestone Oct 23, 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. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document failureDomains for Cluster controllers in the CAPI Book
6 participants