Improve Asset Pipeline documentation [ci-skip] #44482
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
guides/source/asset_pipeline.md
Outdated
| Instead of returning a path such as `/assets/smile.png` (digests are left out | ||
| for readability). The URL generated will have the full path to your CDN. | ||
| The URL generated will have the full path to your CDN instead of having a path | ||
| such as `/assets/smile.png` (digests are left out for readability): |
There was a problem hiding this comment.
It looks like the original text was supposed to conclude the text above it, but, even after your edit, I had some trouble understanding line 868.
What do you think about the following?
--- a/guides/source/asset_pipeline.md
+++ b/guides/source/asset_pipeline.md
@@ -854,23 +854,19 @@ config.asset_host = ENV['CDN_HOST']
NOTE: You would need to set `CDN_HOST` on your server to `mycdnsubdomain
.fictional-cdn.com` for this to work.
-Once you have configured your server and your CDN when you serve a webpage that
-has an asset:
+Once you have configured your server and your CDN, asset paths from helpers such
+as:
```erb
<%= asset_path('smile.png') %>
```
-Instead of returning a path such as `/assets/smile.png` (digests are left out
-for readability). The URL generated will have the full path to your CDN.
+Will be rendered as full CDN URLs like `http://mycdnsubdomain.fictional-cdn.com/assets/smile.png`
+(digest omitted for readability).
-```
-http://mycdnsubdomain.fictional-cdn.com/assets/smile.png
-```
-
-If the CDN has a copy of `smile.png` it will serve it to the browser and your
-server doesn't even know it was requested. If the CDN does not have a copy it
-will try to find it at the "origin" `example.com/assets/smile.png` and then store
+If the CDN has a copy of `smile.png`, it will serve it to the browser, and your
+server doesn't even know it was requested. If the CDN does not have a copy, it
+will try to find it at the "origin" `example.com/assets/smile.png`, and then store
it for future use.
If you want to serve only some assets from your CDN, you can use custom `:host`There was a problem hiding this comment.
great! you've improved the readability even more
|
@la-ruby That looks good! Would you mind also squashing the commits? |
- A dot was appearing in what was supposed to be a compound statement
la-ruby
force-pushed
the
docs/cdn-sentence-fix
branch
from
ffeba0d
to
5699080
Compare
squashed @jonathanhefner |
jonathanhefner
added a commit
to jonathanhefner/rails
that referenced
this pull request
Feb 21, 2022
Improve Asset Pipeline documentation [ci-skip] (cherry picked from commit 54a2824)
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
Before
After