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

Add better liveness/readiness/startup probe docs that we can easily link to #605

Merged
merged 1 commit into from
Jul 26, 2024

Conversation

jessebot
Copy link
Collaborator

@jessebot jessebot commented Jul 26, 2024

Description of the change

Add a dedicated section for Liveness, Readiness, and Startup probes to the README.

Benefits

We've discussed this a number of times in different issues over the years, but for various reasons, users sometimes need to adjust their probes. This gives us a dedicated link we can use to point our community members to as a good troubleshooting step :)

Also, tinier dedicated table that's easier to clean up.

Possible drawbacks

New section in docs that could throw off other PRs? I'm willing to wait on mine to move others forward though 🙏

Applicable issues

There's no one issue specifically, but it was mentioned in #584 that I most recently noticed. Will try to add other issues here if/when I find them 🙏

Would have been nice to link here as well: #368

Additional information

Open to feedback as always :)

Checklist

@jessebot jessebot added the documentation Improvements or additions to documentation label Jul 26, 2024
@jessebot jessebot self-assigned this Jul 26, 2024
@jessebot jessebot merged commit ddc5afc into nextcloud:main Jul 26, 2024
5 checks passed
@jessebot jessebot deleted the add-probes-docs branch July 26, 2024 18:04
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

Successfully merging this pull request may close these issues.

2 participants