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

Rename Netlify preview-only host or host docs via Netlify #195

Open
chalin opened this issue Nov 16, 2022 · 3 comments
Open

Rename Netlify preview-only host or host docs via Netlify #195

chalin opened this issue Nov 16, 2022 · 3 comments

Comments

@chalin
Copy link

chalin commented Nov 16, 2022

Originally posted by @michi-covalent in #164 (comment)

  • Docs have two hosts: I'd like some insights as to why there seem to be two hosting services active for the docs.

https://docs.cilium.io is currently using readthedocs to host the production site. we use cncf netlify account for deploy previews. https://docs-cilium-io.netlify.app comes from that. not sure if there is a way to disable *.netlify.app domain.

The current situation is a bit confusing. Two options come to mind:

  1. Consider renaming the Netlify preview-only host to contain "preview" in the name. That makes it clear that the hosting service is used for previews only (I know of at least one other CNCF project that has done this).
  2. Consider actually hosting the production site and docs via Netlify. I seem to recall a CNCF project that had done this, but I might be confusing this with Mkdocs. I'll have to double check and get back to you. See next comment for details.

Thoughts @michi-covalent @lizrice @xmulligan @qmonnet

@chalin
Copy link
Author

chalin commented Nov 16, 2022

Envoy is the project that hosts everything through Netlify via a single site, including their many versions of docs build with Sphinx & Read the Docs. Here are some links of interested in case you'd like to see how they have it setup:

@xmulligan
Copy link
Member

How urgent is this? We just hired someone you probably know from the cloud native ecosystem to focus on docs. They will be starting in the new year. Can this wait until they join?

@chalin
Copy link
Author

chalin commented Nov 17, 2022

Not urgent. 23Q1 seems fine.

Another option would be to use Netlify snippet injection to add a banner to the preview-only site so that folks who land on it know that it is preview-only. With that in place, it might be unnecessary to rename the Netlify host.

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

No branches or pull requests

2 participants