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.

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

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
@hiddeco hiddeco mentioned this pull request Mar 3, 2022
Closed
5 tasks
stefanprodan
stefanprodan reviewed Mar 8, 2022
View reviewed changes
Copy link
Member

@stefanprodan stefanprodan left a comment •
edited
Loading

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
pjbgf
pjbgf reviewed Mar 10, 2022
View reviewed changes
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
souleb
souleb reviewed Mar 10, 2022
View reviewed changes
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
api/v1beta2/gitrepository_types.go
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.

stefanprodan
stefanprodan approved these changes Mar 11, 2022
View reviewed changes
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
@hiddeco
Document Bucket API v1beta2 spec
5832296 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
Document HelmRepository API v1beta2 spec
86d1d80 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
Document GitRepository API v1beta2 spec
cbffd82 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@darkowlzz @hiddeco
Document HelmChart API v1beta2 spec
f59b48c 
Signed-off-by: Sunny <darkowlzz@protonmail.com>
@darkowlzz @hiddeco
docs/spec: Update the outputs
9e73bfa 
Signed-off-by: Sunny <darkowlzz@protonmail.com>
@darkowlzz @hiddeco
Add more details in helmchart spec doc
8d4fce1 
Details about the source reference, reconcile strategy and artifact
revision value based on the reconcile strategy.

Signed-off-by: Sunny <darkowlzz@protonmail.com>
@hiddeco
docs/spec: document Bucket's Azure Blob support
abf29da 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
doc/spec: use --field-manager in kubectl examples
ff536e1 
To align with:
https://fluxcd.io/docs/faq/#why-are-kubectl-edits-rolled-back-by-flux

Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco
controllers: finetune eventLogf (variant) docs
971caf9 
Signed-off-by: Hidde Beydals <hello@hidde.co>
@hiddeco hiddeco merged commit 7c41249 into main Mar 11, 2022
@hiddeco hiddeco deleted the spec-docs-v1beta2 branch March 11, 2022 09:35
@hiddeco hiddeco mentioned this pull request Mar 11, 2022
Closed
5 tasks
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pjbgf pjbgf pjbgf left review comments

@hiddeco hiddeco hiddeco left review comments

@souleb souleb souleb left review comments

@stefanprodan stefanprodan stefanprodan approved these changes

@phillebaba phillebaba Awaiting requested review from phillebaba

@kingdonb kingdonb Awaiting requested review from kingdonb

Assignees

@darkowlzz darkowlzz

@hiddeco hiddeco

Labels
area/docs Documentation related issues and pull requests
Projects
Maintainers' Focus
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@darkowlzz @stefanprodan @pjbgf @hiddeco @souleb