-
Notifications
You must be signed in to change notification settings - Fork 134
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
Remove duplicate documentation #547
Comments
Actually, I'm not even sure if this is a duplicate or how this website works. But it would be ideal if the entire website was checked into the /docs/ folder in this repository and the whole thing was hosted from GitHub Pages onto one domain name. |
@fulldecent, it's a bit messier than that, unfortunately. The documentation lives on readthedocs.org, and with each build, any new updates are moved there from Podman's GitHub repo, https://github.com/containers/podman/tree/main/docs/source. Then via some DNS hackery, we translate docs.podman.io to the ReadTheDocs site. We've had conversations in the past and haven't landed on a cleaner spot to drop stuff, but still open for suggestions/thoughts. The other thing to consider is we're looking into moving the podman-py docs into the same place eventually. |
Ah, okay, so it's:
Here is an option that puts everything on one domain:
This can be done incrementally. So step 1 can be done in production and changes can be made into production, cutover can happen after it works. A downside of this approach is that the Jekyll configuration lives in containers/podman.io but most content lives in containers/podman. This is harder to perfect styles when running locally. Here's an easier continuing with two domains:
|
@fulldecent I think it's more like:
The last one is through some special settings in DNS and the ReadTheDocs website. The thought that I had muddling around in my noggins was similar to your last one. Moving the docs directory from the podman |
The problem moving the docs directory somewhere else is it would eliminate PRs from checking to make sure new options are documented. With @edsantiago new changes to how we build the content, there is a chance we could link the man pages across. |
The documentation is currently hosted at:
Please remove the docs.podman.io version and redirect it to the apex domain. Having the documentation in only one place makes it easier to find and maintain.
The text was updated successfully, but these errors were encountered: