[#46936] Add documentation for Rails::HealthController #46972
Merged
+50
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
skipkayhil
reviewed
Jan 12, 2023
| @@ -15,6 +15,7 @@ After reading this guide, you will know: | |||
| * How to stream data directly to the user's browser. | |||
| * How to filter sensitive parameters, so they do not appear in the application's log. | |||
| * How to deal with exceptions that may be raised during request processing. | |||
| * About the built-in health check end-point useful for load balancers and uptime monitors. | |||
There was a problem hiding this comment.
Suggested change
| * About the built-in health check end-point useful for load balancers and uptime monitors. | |
| * How to use the built-in health check end-point with load balancers and uptime monitors. |
Should we keep all of these How to ...?
There was a problem hiding this comment.
I intentionally wanted to break up to how-to-chain 😂 basically if we are going to repeat it, then we can prefix that whole list with something that makes sense.. like:
In this guide you will learn how to:
- Stream data directly to the user's browser.
- ...
But that felt out of scope for this PR.
|
Co-authored-by: Hartley McGuire <skipkayhil@gmail.com>
zzak
added a commit
to zzak/rails
that referenced
this pull request
Jan 29, 2023
This is a follow up to rails#46972 where we realized the long list of "How to"s can be rewritten to focus more on the content.
zzak
added a commit
to zzak/rails
that referenced
this pull request
Feb 6, 2023
There were some changes from rails#46972 that I forgot to make here as well. I'm intentionally duplicating this information because it's a new feature and I want users to be able to find it where they are. Whether they are reading the guides online or the API reference somewhere, like in their editor.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.