Fix links inconsistency on Active Storage overview guide [ci-skip] #43111
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
There are two links defined to RedirectController, with backticks and without them. This commit removes the link without backticks for the sake of consistency as discussed here: https://github.com/rails/rails/pull/42703/files#r667270569
The guide's guidelines do not mention anything against linking to the Github repo, but it describes [how to link][] to api.rubyonrails.org works. So I guess that it's better to link "api.rubyonrails.org" when is possible, for instance: classes, modules, and methods. [how to link]: https://guides.rubyonrails.org/ruby_on_rails_guides_guidelines.html#linking-to-the-api
ceritium
changed the title
ceritium
changed the title
|
Thanks, @ceritium! 👍 |
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
Details
Keep RedirectController links consistent
There are two links defined to RedirectController, with backticks and
without them.
This commit removes the link without backticks for the sake of
consistency as discussed here.
Change links from github.com to api.rubyonrails.org
The guide's guidelines do not mention anything against linking to the Github
repo, but it describes how to link to api.rubyonrails.org works.
So I guess that it's better to link "api.rubyonrails.org" when is possible,
for instance: classes, modules, and methods.