Make secret_key_base doc more explicit [ci skip] #45333
Merged
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
This used to be `config.secret_key_base` but was changed to `secrets.secret_key_base` in ae75289 and the `secrets.` prefix was removed in ca18922 when credentials were added. `secret_key_base` by itself doesn't really fit with the rest of this section, so the header and description were changed to document the config value explicitly, and a reference was added to the api docs for the recommended approaches at setting its value. Co-authored-by: Jonathan Hefner <jonathan@hefner.pro>
skipkayhil
force-pushed
the
refine-configuring-docs
branch
from
5c1c908
to
7953c86
Compare
|
Makes sense to me, thanks for the suggestion! |
|
Thank you, @skipkayhil! 😃 (Backported to |
jonathanhefner
added a commit
to jonathanhefner/rails
that referenced
this pull request
Jun 25, 2022
Make secret_key_base doc more explicit [ci skip] (cherry picked from commit bb680b9)
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.
Summary
This used to be
config.secret_key_basebut was changed tosecrets.secret_key_basein ae75289 and thesecrets.prefix wasremoved in ca18922 when credentials were added.
secret_key_baseby itself doesn't really fit with the rest of thissection, so the header and description were changed to document the
config value explicitly, and a reference was added to the api docs for
the recommended approaches at setting its value.