-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Change mentions of "CNAME" -> custom domain #4627
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
How we use symlinks | ||
=================== | ||
|
||
Read the Docs stays highly available by serving all documentation pages out of nginx. | ||
Read the Docs stays highly available by serving all documentation pages out of Nginx. | ||
This means that they never hit our Python layer, | ||
meaning that they never hit our database. | ||
This reduces the total number of servers to serve a request to 1, | ||
|
@@ -12,15 +12,15 @@ Nginx | |
|
||
We handle a couple of different types of requests in nginx: | ||
|
||
* Requests to a readthedocs.org subdomain | ||
* Requests to a CNAME | ||
* Requests to a ``readthedocs.io`` subdomain | ||
* Requests to a custom domain | ||
|
||
Subdomains | ||
---------- | ||
|
||
For subdomains this is a simple lookup. | ||
This doesn't require symlinks, | ||
but it shows the basic logic that we need to replicate. | ||
For subdomains, this is a simple lookup of the project slug, using the subdomain | ||
portion of the request's hostname. This doesn't require symlinks, but it shows | ||
the basic logic that we need to replicate. | ||
|
||
When a user navigates to ``http://pip.readthedocs.org/en/latest/``, | ||
we know that they want the pip documentation. | ||
|
@@ -46,11 +46,11 @@ So we simply serve them the documentation: | |
This will cause things to hit the Python backend, | ||
so that proper action can be taken. | ||
|
||
CNAMEs | ||
------ | ||
Custom domains | ||
-------------- | ||
|
||
CNAMEs add a bit of difficulty, | ||
because at the nginx layer we don't know what documentation to serve. | ||
Custom domains add a bit of difficulty, | ||
because at the Nginx layer we don't know what documentation to serve. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think only the company is capitalized. On the nginx website, it is consistently lower-cased. |
||
When someone requests ``http://docs.fabfile.org/en/latest/``, | ||
we can't look at the URL to know to serve the ``fabric`` docs. | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
customer -> custom