FormingWorlds / PROTEUS

Coupled atmosphere-interior framework to simulate the temporal evolution of rocky planets.
https://fwl-proteus.readthedocs.io
Apache License 2.0
12 stars 1 forks source link

Update URL for documentation #122

Closed stefsmeets closed 3 months ago

stefsmeets commented 3 months ago
          Seems like readthedocs does not approve of updating the url: https://docs.readthedocs.io/en/stable/faq.html#how-do-i-change-my-project-slug-the-url-your-docs-are-served-at

Originally posted by @stefsmeets in https://github.com/FormingWorlds/PROTEUS/issues/121#issuecomment-2269224748

We could try to set up a new project under the new URL and use that instead. readthedocs does not support changing the url through their backend.

timlichtenberg commented 3 months ago

Good for me, homogenising both URLs and the look and feel of the docs is of high priority I think.

lsoucasse commented 3 months ago

Agreed.

stefsmeets commented 3 months ago

Sounds good, I will also see how we can set up subpages for the different projects we have atm (janus, mors, any others?).

stefsmeets commented 3 months ago

I have created a new project under the name fwl-proteus: https://fwl-proteus.readthedocs.io/en/latest/

TODO

Subprojects:

stefsmeets commented 3 months ago

@timlichtenberg Could you give me maintainer access so that I can set up the readthedocs integration (so that it automatically builds on every push)? I don't have the permissions.

timlichtenberg commented 3 months ago

I used this request to unify access rights. @stefsmeets @lsoucasse @nichollsh you should have now unified "maintain" rights on all PROTEUS repositories (at the moment PROTEUS, JANUS, MORS, ZEPHYRUS, SOCRATES) through the "PROTEUS maintainer" team. Please let me know if you encounter issues

nichollsh commented 3 months ago

Thanks, Tim!

stefsmeets commented 3 months ago

Thanks @timlichtenberg! Could you check if you can give us access to webhooks?

timlichtenberg commented 3 months ago

Does this need admin access, and does it need to be configured for each repo or for the organisation?

stefsmeets commented 3 months ago

I believe so, usually it is automatic if you have the rights when you import the project on readthedocs. Feel free to have a go yourself: https://readthedocs.org/dashboard/fwl-proteus/integrations/275696/

The steps are described here: https://docs.readthedocs.io/en/latest/guides/setup/git-repo-manual.html#manual-integration-setup

timlichtenberg commented 3 months ago

I will not be able to do this today or potentially until next week, apologies. To not be the bottleneck, I just gave you temporary admin rights, if that's fine for you. :>

stefsmeets commented 3 months ago

Everything working as expected now, I'm closing this issue.