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

Fix/cleanup-readme #20

Merged
merged 7 commits into from
Apr 24, 2024
Merged

Fix/cleanup-readme #20

merged 7 commits into from
Apr 24, 2024

Conversation

Fovty
Copy link
Member

@Fovty Fovty commented Apr 17, 2024

Motivation

This pull request introduces necessary updates to the README.md files and other documentation to better align with the current deployment strategies using Helm for the project. Basic kubectl deployments -> more robust Helm-based deployment

Changes

  • README Update: The main README.md file has been updated to remove outdated deployment instructions and instead points users to the new Helm chart documentation.
  • Helm Chart README Update: Documentation for py-kube-downscaler using Helm chart added
  • Old Deployment Files Removal: Previous deployment files (config.yaml, deployment.yaml, kustomization.yaml, and rbac.yaml) have been removed as they are no longer necessary with the transition to Helm chart deployment.

TODO

  • I've assigned myself to this PR.

@Fovty Fovty added the fix label Apr 17, 2024
@Fovty Fovty self-assigned this Apr 17, 2024
@Fovty Fovty requested a review from eumel8 April 17, 2024 07:22
@larssb
Copy link

larssb commented Apr 17, 2024

E.g. the KEDA project is hosting their Charts on: https://kedacore.github.io/charts/.

@Fovty
Copy link
Member Author

Fovty commented Apr 17, 2024

Yes, GitHub pages will probably be the way to go. We already have a repo for helm charts: https://github.com/caas-team/helm-charts

I will try to solve this asap

@larssb
Copy link

larssb commented Apr 17, 2024 via email

chart/README.md Outdated Show resolved Hide resolved
chart/README.md Outdated Show resolved Hide resolved
chart/README.md Outdated Show resolved Hide resolved
chart/README.md Outdated Show resolved Hide resolved
@Fovty Fovty requested a review from puffitos April 19, 2024 09:35
Signed-off-by: Bruno Bressi <[email protected]>
@puffitos
Copy link
Member

@Fovty I've formatted the README and corrected the grammar. I don't know about renaming everything to py-kube-downscaler. The language the tool is written it seems irrelevant to its name.

Either way, LGTM now 👍

@Fovty
Copy link
Member Author

Fovty commented Apr 22, 2024

@puffitos Thank you for the review! We decided to rename the tool because the plan was to possibly write a Kubernetes dowscaler in GO in the future.

@Fovty Fovty merged commit b9c23ca into main Apr 24, 2024
2 checks passed
@Fovty Fovty deleted the fix/cleanup-readme branch April 24, 2024 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants