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

Docs: expand "Custom domains" to mention subprojects #11593

Open
humitos opened this issue Sep 9, 2024 · 0 comments
Open

Docs: expand "Custom domains" to mention subprojects #11593

humitos opened this issue Sep 9, 2024 · 0 comments
Labels
Improvement Minor improvement to code Needed: documentation Documentation is required

Comments

@humitos
Copy link
Member

humitos commented Sep 9, 2024

We should communicate to our users that before adding another custom domain for their project, they should probably consider using subprojects. This would avoid having:

  • users.docs.company.com
  • sales.docs.company.com
  • tech.docs.company.com

There were some companies that followed the approach to add a custom domain we have documented at https://docs.readthedocs.io/en/stable/guides/custom-domains.html but they only needed to follow that guide only once and then use subprojects for the other projects.

We should probably promote using docs.company.com as the main documentation and then use a subproject for the others, exposing them at docs.company.com/projects/users/ instead.

I'm writing this issue based on user feedback from a few customers.

Front logo Front conversations

@humitos humitos added Improvement Minor improvement to code Needed: documentation Documentation is required labels Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: documentation Documentation is required
Projects
Status: Planned
Development

No branches or pull requests

1 participant