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

Misleading sources of documentation #4286

Closed
jamesp opened this issue Aug 18, 2021 · 9 comments
Closed

Misleading sources of documentation #4286

jamesp opened this issue Aug 18, 2021 · 9 comments
Assignees
Labels
Peloton 🚴‍♂️ Target a breakaway issue to be caught and closed by the peloton Type: Documentation

Comments

@jamesp
Copy link
Member

jamesp commented Aug 18, 2021

📚 Documentation

Where is this documentation being produced? Can we turn it off? It is out of date.

https://scitools-docs.github.io/iris/master/index.html

@pp-mo pp-mo added the Peloton 🚴‍♂️ Target a breakaway issue to be caught and closed by the peloton label Aug 19, 2021
@trexfeathers
Copy link
Contributor

Get it out, get it out!

@tkknight
Copy link
Contributor

Is it now understood where this doc instance comes from?

@rcomer
Copy link
Member

rcomer commented Aug 24, 2021

Is this the culprit? https://github.com/SciTools-docs/iris

@rcomer
Copy link
Member

rcomer commented Aug 24, 2021

#2610 👀

@jamesp
Copy link
Member Author

jamesp commented Aug 24, 2021

Yep that looks like it might be it!

@jamesp
Copy link
Member Author

jamesp commented Aug 24, 2021

It looks like it previously was being published by Jenkins, but no longer is. I don't have access to the control panel for this account. Could someone else in @SciTools/admins disable it, or redirect (maybe http 301 if possible) to our RTD instance?

@pp-mo
Copy link
Member

pp-mo commented Aug 24, 2021

Could someone else in @SciTools/admins disable it

Agreed, it seems with the permission, you can just disable the github "Pages" option
https://guides.github.com/features/pages/#setup

@tkknight
Copy link
Contributor

I do not seem to have permissions to do anything on https://github.com/SciTools-docs/iris.

For reference, we have https://github.com/SciTools/scitools.org.uk/tree/master/iris/docs which is the docs for Scitools that includes links to the docs for Iris and Cartopy published via https://scitools.org.uk/. After Iris 2.4 we moved to ReadTheDocs (RTD) and will auto redirect to RTD when selecting the latest Iris.

If someone has permissions for https://github.com/SciTools-docs/iris, I think we can either disable the pages or add a simple redirect like we do on the scitools.org.uk repo, see https://github.com/SciTools/scitools.org.uk/blob/master/iris/docs/stable_readthedocs/index.html - as per @jamesp suggested.

Perhaps @bjlittle has permissions, or @pelson who I note was the first to commit to master before the automated travis commits.

@bjlittle
Copy link
Member

Done 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Peloton 🚴‍♂️ Target a breakaway issue to be caught and closed by the peloton Type: Documentation
Projects
None yet
Development

No branches or pull requests

6 participants