Pylons
Documentation link on PyPi is broken
Bug Report
On page https://pypi.org/project/PasteDeploy/ in Project links section "Documentation" link leads to https://docs.pylonsproject.org/projects/pastedeploy/en/latest/ which produces HTTP 404 error.
To Reproduce Steps to reproduce the behavior:
- Go to https://pypi.org/project/PasteDeploy/
- Click on Documentation
- See error 404
Expected behavior Some kind of documentation
Screenshots
There's a squatter on both the Pylons Project project names pastedeploy and paste using the old BitBucket repos on RTD.
- https://readthedocs.org/profiles/ilseedavid/
- https://readthedocs.org/projects/pastedeploy/
- https://readthedocs.org/projects/paste/
The Pylons Project can start a claim with RTD per this process, which takes up to 6 weeks:
https://docs.readthedocs.io/en/stable/abandoned-projects.html
Alternatively someone can contact the squatter and ask them nicely to unsquat.
I happen to know this because I recently started the process for Plone.
Should not the broken links be removed from https://github.com/Pylons/pastedeploy/blob/c13164986cb62f9d36f39699062c858a4fe01f49/setup.cfg#L39 ?
I found the documents, but I think they are quite old. Here is the link: https://pastedeploy.readthedocs.io/en/latest/ . In the picture, you can see it was discussing version 1.0, which is currently outdated. If you want to read the documents, it might still be helpful.
I have opened a support request with RTD.
I am considering an alternative where maybe we can proxy things, but I'm not sure it'll actually work. We could claim pastedeploy-official and then setup our nginx config to rewrite pastedeploy to pastedeploy-official possibly. I'm worried that it wouldn't work correctly with the little embedded popup on the page though. I've asked them for some guidance.
Through my support request they gave me control of the RTD project. I'll work on fixing this up and integrating it into our structure soon.
@stevepiercy I also added you as a maintainer if you have any desire to sort out RTD config.
@mmerickel thanks, invite accepted. I have a backlog of open source docs reviews, so maybe next week.
@mmerickel @digitalresistor I don't recall how to set up the bits and pieces for https://docs.pylonsproject.org/projects/pastedeploy/en/latest/ to point to https://pastedeploy.readthedocs.io/latest/. IIRC, these is handled on the Linode.
Other than that, the docs are building with the latest version.
I can also set up pull request previews, if desired. I've been doing that for Plone, so it's a habit now.
@mmerickel @digitalresistor I don't recall how to set up the bits and pieces for https://docs.pylonsproject.org/projects/pastedeploy/en/latest/ to point to https://pastedeploy.readthedocs.io/latest/. IIRC, these is handled on the Linode.
Other than that, the docs are building with the latest version.
I can also set up pull request previews, if desired. I've been doing that for Plone, so it's a habit now.
Nope, not handled on Linode. It's handled on the RTD side of things.
Gotta add it as a subproject here: https://app.readthedocs.org/dashboard/pylons/subprojects/
I don't have access to the paste deploy project so I can't add it.
In https://app.readthedocs.org/dashboard/pastedeploy/edit/ :
- I set the default branch to
main. - The default version is "latest", which is the content from the
mainbranch. - I changed "URL versioning scheme" to "Multiple versions with translations" (which is silly because there are no translations for any Pylons Project projects) 🤡 .
- I rebuilt "latest". Success! https://docs.pylonsproject.org/projects/pastedeploy/en/latest/
- There is a "stable" version that fails to build. RTD selected the commit of
83ba75ca, which was the last release, as described in https://docs.readthedocs.io/en/stable/versions.html#versions-are-git-tags-and-branches. A new release will pick up the.readthedocs.yamlfile frommainand should build successfully. @mmerickel @digitalresistor would one of you please do the honors? Thank you!