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

Base www.zodb.org on zodb.readthedocs.io #336

Open
icemac opened this issue Feb 19, 2021 · 14 comments
Open

Base www.zodb.org on zodb.readthedocs.io #336

icemac opened this issue Feb 19, 2021 · 14 comments
Assignees

Comments

@icemac
Copy link
Member

icemac commented Feb 19, 2021

Currently https://www.zodb.org shows the content of https://readthedocs.org/projects/zodborg/ thus it outdated because there is no web hook to automatically update that RTD project.

In #335 was reported that https://zodb.readthedocs.io/ is now the place where the ZODB documentation lives on RTD. It gets automatically updated with new changes in GitHub. (I added @jimfulton as developer to that project.)

Who is able to change the source for https://www.zodb.org? @jimfulton @dataflake

@dataflake
Copy link
Member

I just changed the DNS entry for www.zope.org to point at zodb.readthedocs.io. Don't forget: For this to work seamlessly the RTD configuration for zodb.readthedocs.io must have a setting that allows www.zodb.org as another name for that location. I don't have access to that RTD configuration so I cannot check myself.

@dataflake
Copy link
Member

P.S.: Just to clarify, this is not a change to the "source" for www.zodb.org. www.zope.org is just a DNS CNAME record that points to something.

@icemac
Copy link
Member Author

icemac commented Feb 19, 2021

@dataflake I added you as developer for https://readthedocs.org/projects/zodb/. So you can configure it correctly.

@icemac
Copy link
Member Author

icemac commented Feb 19, 2021

Is there a chance that https://www.zodb.org redirects to https://www.zodb.org/en/latest/ instead of http://www.zodb.org/en/latest/?

@dataflake
Copy link
Member

As I said, this is a DNS CNAME record, it has nothing to do with the protocol. What happens with those requests must be configured at RTD. You could look into the settings there to se if there's a switch to redirect everything to HTTPS.

@icemac
Copy link
Member Author

icemac commented Mar 30, 2021

http://www.zodb.org still seems to point to the public address of https://readthedocs.org/projects/zodborg/ which has a 2+ year old copy of the ZODB documentation. The current one is at https://zodb-docs.readthedocs.io/
https://zodb.readthedocs.io/ redirects to http://www.zodb.org so it also displays the old documentation status even though the RTD-Job of https://readthedocs.org/projects/zodb/ produces the current documentation.

@icemac
Copy link
Member Author

icemac commented Mar 30, 2021

Where is the DNS CNAME configured? At RTD in https://readthedocs.org/projects/zodborg/ where only @jimfulton has access?

@dataflake
Copy link
Member

DNS is at zoneedit.com. (RTD has nothing at all to do with DNS, all you do there is configure that a certain hostname may be used to access a RTD project). This is the current configuration:

  • zodb.org points to the IP of the VM I set up. Its only function is to redirect all traffic to https://www.zodb.org. That was done so that we still have some control over where the traffic flows.
  • www.zodb.org is a CNAME pointing to zodb.readthedocs.io

If you need me to change anything let me know. I don't know what the configuration at RTD looks like, though.

@dataflake
Copy link
Member

@icemac From your description it sounds like www.zodb.org should become a CNAME for zodb-docs.readthedocs.io. Can you add me as a maintainer at https://readthedocs.org/projects/zodb-docs/ so I can try to make this work?

@icemac
Copy link
Member Author

icemac commented Mar 31, 2021

That's strange: https://zodb.readthedocs.io/en/latest/ and http://www.zodb.org/en/latest/ show a different content. (The older version is on zodb.org)

@icemac From your description it sounds like www.zodb.org should become a CNAME for zodb-docs.readthedocs.io. Can you add me as a maintainer at https://readthedocs.org/projects/zodb-docs/ so I can try to make this work?

No, zodb.readthedocs.io is just fine. zodb-docs.readthedocs.io is a separate RTD project which now has the same content as zodb.readthedocs.io but not such a nice sub-domain name. I think zodb-docs.readthedocs.io can be removed after zodb.org is displaying the current version of the documentation.

@dataflake
Copy link
Member

OK, so it looks like there's an issue with what RTD displays when it receives traffic destined for www.zodb.org. There is some other project (I do not know which because I am only admin at https://readthedocs.org/dashboard/zodb) that has www.zope.org in the Admin | Domains configuration section. Trying to add this host to the domains of the canonical ZODB project dgows a message that the host is already set up elsewhere on RTD.

@icemac Can you visit any of those ZODB-related RTD projects where you are admin and make sure all domains are deleted on all of them?

@dataflake
Copy link
Member

For the moment I have changed the configuration so the following is true:

  • www.zodb.org now points to the VM under my control, which redirects all access to https://zodb.org
  • zodb.org is set up as canonical external URL at the zodb RTD project

I had hoped to make it the other way around whereby www.zodb.org is the canonical URL everything redirects to, but it looks like we cannot get at the place where www.zodb.org is already set up as external domain for another RTD project. So now zodb.org is the canonical URL.

@icemac
Copy link
Member Author

icemac commented Apr 12, 2021

www.zodb.org now displays the current version of the content. Thank you @dataflake!

Only https://readthedocs.org/projects/zodborg/ can be the repository which also defines www.zodb.org als canonical URL. @jimfulton is the only developer for this RTD project. Jim, could you please add me (icemac) to this RTD project, so we can clean up further?

@azmeuk
Copy link
Member

azmeuk commented Jul 28, 2023

I just stumbled upon this: if there is no news from @jimfulton one could simply ask RTD to get the repository back.

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

No branches or pull requests

4 participants