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

Refactor: Remove docs which overlap with Flux website #746

Merged
merged 1 commit into from
Oct 19, 2022

Conversation

stefanprodan
Copy link
Member

@stefanprodan stefanprodan commented Oct 19, 2022

Changes:

  • Explicitly call kustomize-controller a Flux component
  • Remove guide form README.md which overlaps with Flux website
  • Add links to Flux website
  • Make small corrections to the API docs

Ref: #663 #664

@stefanprodan stefanprodan added the area/docs Documentation related issues and pull requests label Oct 19, 2022
Copy link
Member

@hiddeco hiddeco left a comment

Choose a reason for hiding this comment

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

I do not think that this closes #664, as it is still structured in a different way than the new spec documentation around sources (e.g. "Writing a Kustomization spec" like https://github.com/fluxcd/source-controller/blob/main/docs/spec/v1beta2/buckets.md#writing-a-bucket-spec, and explicit mention of fields and their behavior).

Comment on lines +28 to +29
- detects drift between the desired and state and cluster state
- corrects drift by patching objects with Kubernetes server-side apply
Copy link
Member

Choose a reason for hiding this comment

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

Nit: different list style?

> Kubernetes manifests and configuration files referenced in the kustomization.yaml.
> If your Git repository or S3 bucket contains only plain manifests,
> then a kustomization.yaml will be automatically generated.
> **Note** that if the source contains a `kustomization.yaml` file, then it should also contain
Copy link
Member

Choose a reason for hiding this comment

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

In the "new way of writing specs", I think notes have the format of:

**Note:** If the resource contains ...

opposed to putting them in a quote block.

@stefanprodan
Copy link
Member Author

I do not think that this closes #664

It doesn't, I just added a ref to it.

@hiddeco
Copy link
Member

hiddeco commented Oct 19, 2022

Ah, absolutely my bad for misreading.

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
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.

2 participants