-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Rework custom domains docs #6844
Conversation
- Merge docs for custom domains for .org and .com - Merge `Custom domain support` and `Custom Domain SSL` sections - Simplify some paragraphs
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.
Some small notes for now.
It might be worth writing a small amount of JS that lets us change the active tab in a link. I don't think it would be hard to do (eg. |
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.
This is a good start. I wish we had a way to add redirects to the .yaml
config so we could automatically deploy them when we merge this PR.
Or, even better... #6621 |
Co-Authored-By: Eric Holscher <[email protected]>
Yeah, I'll see if I can implement it in the extension itself. |
I wrote a little js file to allow us to expand a tab, the sphinx-tabs repo looks like a little abandoned https://github.com/djungelorm/sphinx-tabs/pulls, I'll see if I can implement this later in the original extension, to allow us to link from a role |
The only thing missing is what to do with the |
Yea, I think thats a good idea for now. |
It would be cool if the JS updated the URL when you switched tabs, but that might be too much for now 👍 |
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.
This is a huge improvement. We should create the redirect before we merge this, then it will start working once we ship it 👍
if (tabName !== null) { | ||
const tab = $('a.item > div:contains("' + tabName + '")'); | ||
if (tab.length > 0) { | ||
tab.click(); |
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.
💯
This is maybe a good suggestion for upstream 😄
I created the redirect! |
https://docs.readthedocs.io/en/latest/commercial/custom_domains.html redirects correctly! |
Custom domain support
andCustom Domain SSL
sectionsI'm not sure what to do with the
Proxy SSL
section, looks like we don't support this on .com? Or do we want to support this for new projects on .org?And I was about to remove the dig example, not sure.
preview at https://docs--6844.org.readthedocs.build/en/6844/custom_domains.html
One downside is that we can't link to a tab (executablebooks/sphinx-tabs#47).
But we could make the .com tab the default if we want.
Note: we need to create a redirect after this is released