Skip to content

API v1beta2 spec docs#599

Merged
hiddeco merged 9 commits intomainfrom
spec-docs-v1beta2
Mar 11, 2022
Merged

API v1beta2 spec docs#599
hiddeco merged 9 commits intomainfrom
spec-docs-v1beta2

Conversation

@darkowlzz
Copy link
Copy Markdown
Contributor

No description provided.

@hiddeco hiddeco added the area/docs Documentation related issues and pull requests label Mar 2, 2022
@darkowlzz darkowlzz force-pushed the spec-docs-v1beta2 branch from 3cc06aa to 7be5cdd Compare March 3, 2022 13:53
Copy link
Copy Markdown
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
Copy Markdown
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 force-pushed the spec-docs-v1beta2 branch from 978d3b0 to 0a33829 Compare March 10, 2022 10:14
@hiddeco hiddeco marked this pull request as ready for review March 10, 2022 10:15
Copy link
Copy Markdown
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. 👍

Comment thread api/v1beta2/bucket_types.go Outdated
Comment thread api/v1beta2/bucket_types.go Outdated
Comment thread controllers/helmrepository_controller.go Outdated
Comment thread docs/spec/v1beta2/gitrepositories.md Outdated
Comment thread api/v1beta2/gitrepository_types.go Outdated
Comment thread api/v1beta2/gitrepository_types.go
Comment thread api/v1beta2/gitrepository_types.go Outdated
ToPath string `json:"toPath"`
}

// GetFromPath returns the specified FromPath.
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Sunny <darkowlzz@protonmail.com>
Signed-off-by: Sunny <darkowlzz@protonmail.com>
Details about the source reference, reconcile strategy and artifact
revision value based on the reconcile strategy.

Signed-off-by: Sunny <darkowlzz@protonmail.com>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco force-pushed the spec-docs-v1beta2 branch from 3f867f6 to 971caf9 Compare March 11, 2022 09:04
@hiddeco hiddeco merged commit 7c41249 into main Mar 11, 2022
@hiddeco hiddeco deleted the spec-docs-v1beta2 branch March 11, 2022 09:35
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

None yet

Development

Successfully merging this pull request may close these issues.

5 participants