Skip to content
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

Merged
merged 8 commits into from Apr 13, 2020
Merged

Rework custom domains docs #6844

merged 8 commits into from Apr 13, 2020

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Apr 1, 2020

  • Merge docs for custom domains for .org and .com
  • Merge Custom domain support and Custom Domain SSL sections
  • Simplify some paragraphs
  • Group the notes about cloudflare users

I'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

- Merge docs for custom domains for .org and .com
- Merge `Custom domain support` and `Custom Domain SSL` sections
- Simplify some paragraphs
@stsewd stsewd requested a review from a team Apr 1, 2020
Copy link
Member

@humitos humitos left a comment

Some small notes for now.

docs/custom_domains.rst Outdated Show resolved Hide resolved
docs/custom_domains.rst Outdated Show resolved Hide resolved
@ericholscher
Copy link
Member

ericholscher commented Apr 6, 2020

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.

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. docs.rtd.io/custom_domains/?tab=commercial)

Copy link
Member

@ericholscher ericholscher left a comment

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.

docs/custom_domains.rst Outdated Show resolved Hide resolved
docs/custom_domains.rst Outdated Show resolved Hide resolved
docs/custom_domains.rst Outdated Show resolved Hide resolved
docs/custom_domains.rst Outdated Show resolved Hide resolved
@humitos
Copy link
Member

humitos commented Apr 7, 2020

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

stsewd and others added 3 commits Apr 7, 2020
Co-Authored-By: Eric Holscher <25510+ericholscher@users.noreply.github.com>
@stsewd
Copy link
Member Author

stsewd commented Apr 7, 2020

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. docs.rtd.io/custom_domains/?tab=commercial)

Yeah, I'll see if I can implement it in the extension itself.

@stsewd
Copy link
Member Author

stsewd commented Apr 7, 2020

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 :ref:`tabs-...`

https://docs--6844.org.readthedocs.build/en/6844/custom_domains.html?tab=Read%20the%20Docs%20for%20Business#custom-domain-support

https://docs--6844.org.readthedocs.build/en/6844/custom_domains.html?tab=Read%20the%20Docs%20Community#custom-domain-support

@stsewd
Copy link
Member Author

stsewd commented Apr 7, 2020

The only thing missing is what to do with the Proxy SSL section, should I put a note that this is only for .org?

@stsewd stsewd requested a review from a team Apr 7, 2020
@ericholscher
Copy link
Member

ericholscher commented Apr 9, 2020

The only thing missing is what to do with the Proxy SSL section, should I put a note that this is only for .org?

Yea, I think thats a good idea for now.

@ericholscher
Copy link
Member

ericholscher commented Apr 9, 2020

https://docs--6844.org.readthedocs.build/en/6844/custom_domains.html?tab=Read%20the%20Docs%20for%20Business#custom-domain-support

It would be cool if the JS updated the URL when you switched tabs, but that might be too much for now 👍

Copy link
Member

@ericholscher ericholscher left a comment

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();
Copy link
Member

@humitos humitos Apr 13, 2020

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 😄

@stsewd
Copy link
Member Author

stsewd commented Apr 13, 2020

I created the redirect!

@stsewd stsewd merged commit 95a2eaf into master Apr 13, 2020
2 checks passed
@stsewd stsewd deleted the rework-custom-domains-docs branch Apr 13, 2020
@stsewd
Copy link
Member Author

stsewd commented Apr 13, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants