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

improve readme docs on pod reaper #40

Open
grosser opened this issue Oct 23, 2020 · 3 comments
Open

improve readme docs on pod reaper #40

grosser opened this issue Oct 23, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@grosser
Copy link

grosser commented Oct 23, 2020

it has lots of options and functions and the readme does not mention any of them
should be improved to encourage adoption and for users to know what they install

@eytan-avisror
Copy link
Collaborator

Might still need update, but there are additional docs regarding flags here:
https://github.com/keikoproj/governor/tree/master/pkg/reaper

@eytan-avisror eytan-avisror added the documentation Improvements or additions to documentation label Oct 23, 2020
@grosser
Copy link
Author

grosser commented Oct 23, 2020 via email

@eytan-avisror
Copy link
Collaborator

@grosser thanks for the feedback
Leaving this issue open so we can potentially improve the main readme + package specific docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants