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

API v1beta2 spec docs #599

Merged
merged 9 commits into from
Mar 11, 2022
Merged

API v1beta2 spec docs #599

merged 9 commits into from
Mar 11, 2022

Conversation

darkowlzz
Copy link
Contributor

No description provided.

@hiddeco hiddeco added the area/docs Documentation related issues and pull requests label Mar 2, 2022
Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

All kubectl command must contain --field-manager=flux-client-side-apply otherwise kustomize-controller will remove the annotations or any other field that's not in the desired state.

Docs here: https://fluxcd.io/docs/faq/#why-are-kubectl-edits-rolled-back-by-flux

@stefanprodan
Copy link
Member

I would add flux create secret examples for each Git/Helm auth type.

@hiddeco hiddeco force-pushed the spec-docs-v1beta2 branch 3 times, most recently from 687af2f to 978d3b0 Compare March 9, 2022 11:47
@hiddeco hiddeco marked this pull request as ready for review March 10, 2022 10:15
Copy link
Member

@pjbgf pjbgf left a comment

Choose a reason for hiding this comment

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

Sharing some small nits, but overall it is looking really good. 👍

api/v1beta2/bucket_types.go Outdated Show resolved Hide resolved
api/v1beta2/bucket_types.go Outdated Show resolved Hide resolved
controllers/helmrepository_controller.go Outdated Show resolved Hide resolved
api/v1beta2/gitrepository_types.go Outdated Show resolved Hide resolved
api/v1beta2/gitrepository_types.go Show resolved Hide resolved
api/v1beta2/gitrepository_types.go Outdated Show resolved Hide resolved
ToPath string `json:"toPath"`
}

// GetFromPath returns the specified FromPath.
Copy link
Member

Choose a reason for hiding this comment

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

I feel like func (in *GitRepositoryInclude) FromPath() string and func (in *GitRepositoryInclude) ToPath() string are more intuitive names.

Copy link
Member

Choose a reason for hiding this comment

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

Fields and methods can not bear the same name.

Copy link
Member

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM

Thanks @darkowlzz and @hiddeco

PS> I really like the new docs structure, we need to create an issue for rewriting the docs in all controllers based on this PR.

hiddeco and others added 9 commits March 11, 2022 10:04
Details about the source reference, reconcile strategy and artifact
revision value based on the reconcile strategy.

Signed-off-by: Sunny <[email protected]>
@hiddeco hiddeco merged commit 7c41249 into main Mar 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation related issues and pull requests
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants