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

Add the ability to delete "legacy" documentation #582

Closed
dstufft opened this Issue Aug 5, 2015 · 19 comments

Comments

Projects
None yet
@dstufft
Member

dstufft commented Aug 5, 2015

If a project has existing legacy documentation hosted on pythonhosted.org, we should allow them to delete this documentation. This should come with appropriate warnings that this is a one time, destructive operation that cannot be undone, that new uploads of documentation are no longer allowed and that they should not do it until they've moved their documentation hosting elsewhere.

We should probably include at least a suggestion of using ReadTheDocs here.

This should also provide people with the option to add a redirect when deleting their documentation so that they can redirect to their new location.

@dstufft dstufft added this to the Become PyPI milestone Aug 5, 2015

@dstufft dstufft modified the milestone: Launch Apr 18, 2016

@brainwane brainwane added this to the 3) Feature parity with PyPI milestone Jun 30, 2016

@nlhkabu

This comment has been minimized.

Show comment
Hide comment
@nlhkabu

nlhkabu Jul 3, 2016

Member

@dstufft - is this required for shut down, or can we move it to post launch?

Member

nlhkabu commented Jul 3, 2016

@dstufft - is this required for shut down, or can we move it to post launch?

@dstufft dstufft removed this from the 2: Shut Down Legacy PyPI milestone Jul 3, 2016

@dstufft

This comment has been minimized.

Show comment
Hide comment
@dstufft

dstufft Jul 3, 2016

Member

It can be post shut down, it doesn't currently exist.

Member

dstufft commented Jul 3, 2016

It can be post shut down, it doesn't currently exist.

@dstufft dstufft added this to the 2: Shut Down Legacy PyPI milestone Jul 3, 2016

@dstufft

This comment has been minimized.

Show comment
Hide comment
@dstufft

dstufft Jul 3, 2016

Member

Actually I lied-- We're not allowing new docs to be uploaded in Warehouse, so we'll want people to be able to delete their existing documentation so they can migrate to something else before we shut down legacy.

Member

dstufft commented Jul 3, 2016

Actually I lied-- We're not allowing new docs to be uploaded in Warehouse, so we'll want people to be able to delete their existing documentation so they can migrate to something else before we shut down legacy.

@bbayles

This comment has been minimized.

Show comment
Hide comment
@bbayles

bbayles Dec 3, 2016

Posting very late to an old thread, but adding my support for adding this ability. For more-itertools we added docs to RTD, but the old ones still show up on Google and there's a link to them on PyPI.

bbayles commented Dec 3, 2016

Posting very late to an old thread, but adding my support for adding this ability. For more-itertools we added docs to RTD, but the old ones still show up on Google and there's a link to them on PyPI.

@bbayles

This comment has been minimized.

Show comment
Hide comment
@bbayles

bbayles Dec 3, 2016

Oh, there's a button for this! Never mind.

bbayles commented Dec 3, 2016

Oh, there's a button for this! Never mind.

@computron

This comment has been minimized.

Show comment
Hide comment
@computron

computron Jul 23, 2017

This should also provide people with the option to add a redirect when deleting their documentation so that they can redirect to their new location.

Is there any redirect option yet? I've erased my pythonhosted docs (which can't be updated) and moved my docs elsewhere, but there are published academic papers and other materials that refer to documentation for my package as being on pythonhosted.org. Currently, following any of those links just returns an error page with no guidance of where to go next. I'm sure many users can eventually figure out where to go with Google, but it would be much better if pythonhosted allowed for a way to redirect or at least list the location of the updated docs.

computron commented Jul 23, 2017

This should also provide people with the option to add a redirect when deleting their documentation so that they can redirect to their new location.

Is there any redirect option yet? I've erased my pythonhosted docs (which can't be updated) and moved my docs elsewhere, but there are published academic papers and other materials that refer to documentation for my package as being on pythonhosted.org. Currently, following any of those links just returns an error page with no guidance of where to go next. I'm sure many users can eventually figure out where to go with Google, but it would be much better if pythonhosted allowed for a way to redirect or at least list the location of the updated docs.

@mperrin

This comment has been minimized.

Show comment
Hide comment
@mperrin

mperrin Aug 14, 2017

Let me second @computron's suggestion - it would be really nice to be able to redirect from the pythonhosted.org docs to our new docs now hosted on readthedocs.org. Thanks much.

mperrin commented Aug 14, 2017

Let me second @computron's suggestion - it would be really nice to be able to redirect from the pythonhosted.org docs to our new docs now hosted on readthedocs.org. Thanks much.

@lingthio

This comment has been minimized.

Show comment
Hide comment
@lingthio

lingthio Sep 5, 2017

Wow. Seriously? This is such a major oversight. You expect me to choose between a bad option:

  • Delete the pythonhosted.org page, so that my user base can't find it.

and a worse option:

  • Live with two docs pages, one of them out-dated, which for a while will show up with higher search rankings?

Furthermore, google search offers almost no search results regarding this issue. It took me over an hour to find this. At least make this info available on the pypi edit project page. PLEASE.

lingthio commented Sep 5, 2017

Wow. Seriously? This is such a major oversight. You expect me to choose between a bad option:

  • Delete the pythonhosted.org page, so that my user base can't find it.

and a worse option:

  • Live with two docs pages, one of them out-dated, which for a while will show up with higher search rankings?

Furthermore, google search offers almost no search results regarding this issue. It took me over an hour to find this. At least make this info available on the pypi edit project page. PLEASE.

@ncoghlan

This comment has been minimized.

Show comment
Hide comment
@ncoghlan

ncoghlan Nov 26, 2017

Member

@dstufft, as per @lingthio's comment above, and the distutils-sig thread at https://mail.python.org/pipermail/distutils-sig/2017-September/031453.html, this is no longer a potential future problem, it's an actual problem right now: with pypi.org providing the only artifact upload interface, there's no longer any way for package maintainers to update their pythonhosted.org documentation.

Mere deletion isn't adequate, since that doesn't allow previously published links to be transparently redirected (preferable), or at least to reach a "These docs are no longer here, go to [other page] instead" page.

As prior art for handling this more gracefully, https://docs.readthedocs.io/en/latest/user-defined-redirects.html would be worth looking at.

It may even be worth chatting to @ericholscher to see whether or not it might be possible to migrate the pythonhosted.org pages into ReadTheDocs as static HTML, such that the redirect strategy literally is to use RTD's existing support for this.

Member

ncoghlan commented Nov 26, 2017

@dstufft, as per @lingthio's comment above, and the distutils-sig thread at https://mail.python.org/pipermail/distutils-sig/2017-September/031453.html, this is no longer a potential future problem, it's an actual problem right now: with pypi.org providing the only artifact upload interface, there's no longer any way for package maintainers to update their pythonhosted.org documentation.

Mere deletion isn't adequate, since that doesn't allow previously published links to be transparently redirected (preferable), or at least to reach a "These docs are no longer here, go to [other page] instead" page.

As prior art for handling this more gracefully, https://docs.readthedocs.io/en/latest/user-defined-redirects.html would be worth looking at.

It may even be worth chatting to @ericholscher to see whether or not it might be possible to migrate the pythonhosted.org pages into ReadTheDocs as static HTML, such that the redirect strategy literally is to use RTD's existing support for this.

@fungi

This comment has been minimized.

Show comment
Hide comment
@fungi

fungi Nov 26, 2017

As a compromise between adding a new complex interaction for user-defined redirects and/or parsing special links out of descriptions/metadata, would it be sufficient simply to redirect pythonhosted docs for any package missing them to the corresponding package page? Then at least if the project has a Documentation or Home Page link in their description or metadata the user can continue by following it to the current docs.

fungi commented Nov 26, 2017

As a compromise between adding a new complex interaction for user-defined redirects and/or parsing special links out of descriptions/metadata, would it be sufficient simply to redirect pythonhosted docs for any package missing them to the corresponding package page? Then at least if the project has a Documentation or Home Page link in their description or metadata the user can continue by following it to the current docs.

@ronaldoussoren

This comment has been minimized.

Show comment
Hide comment
@ronaldoussoren

ronaldoussoren Nov 26, 2017

Redirecting to an URL in the metadata would be nicer, either Home-page or a specific Project-URL (and the latter would give projects more control on where the documentation link redirects to).

In the longer run #1419, which is mostly about being able to add links to the sidebar on PyPI.org through Project-URL, is a nicer solution.

P.S. For a long time I didn't have links to documentation in my long-description because PyPI legacy automatically ads a link to documentation hosted on pythonhosted.org. I only recently added links to the long description because that doesn't work with warehouse and I couldn't get the same functionality through Project-URL links.

ronaldoussoren commented Nov 26, 2017

Redirecting to an URL in the metadata would be nicer, either Home-page or a specific Project-URL (and the latter would give projects more control on where the documentation link redirects to).

In the longer run #1419, which is mostly about being able to add links to the sidebar on PyPI.org through Project-URL, is a nicer solution.

P.S. For a long time I didn't have links to documentation in my long-description because PyPI legacy automatically ads a link to documentation hosted on pythonhosted.org. I only recently added links to the long description because that doesn't work with warehouse and I couldn't get the same functionality through Project-URL links.

@ericholscher

This comment has been minimized.

Show comment
Hide comment
@ericholscher

ericholscher Dec 7, 2017

I'd be interested in helping get something set up.

ericholscher commented Dec 7, 2017

I'd be interested in helping get something set up.

@nlhkabu

This comment has been minimized.

Show comment
Hide comment
@nlhkabu

nlhkabu Jan 18, 2018

Member

I've added a space for this in the new UI:

screenshot from 2018-01-18 06-29-44

For now, this tab will be commented out, but this interface should give us the flexibility to add a specific documentation page and address this issue.

Member

nlhkabu commented Jan 18, 2018

I've added a space for this in the new UI:

screenshot from 2018-01-18 06-29-44

For now, this tab will be commented out, but this interface should give us the flexibility to add a specific documentation page and address this issue.

@di

This comment has been minimized.

Show comment
Hide comment
@di

di Jan 18, 2018

Member

FYI, Project-URLs have been fixed in #2813.

Member

di commented Jan 18, 2018

FYI, Project-URLs have been fixed in #2813.

@ewdurbin

This comment has been minimized.

Show comment
Hide comment
@ewdurbin

ewdurbin Feb 12, 2018

Member

This is In Progress. Implementing the Delete Docs button is one part, but there is a larger story.

A discussion happened late last year with Read The Docs (RTD) about what a good approach for handling a link between documentation and the package index might be, as warehouse isn't well suited to serve as a documentation host moving forward.

The summary is that post launch, we may be able to implement some sort of handoff to "introduce" a user to RTD for the purposes of authenticating them as valid owners of a namespace on their site that indicates "canonical" package documentation hosting.

Implementing a "redirect" functionality is still up in the air, as it would effectively communicate that we're not going to do anything for package doc hosting moving forward... which hasn't been decided. Although I agree that it would be a good escape hatch in the interim before a more full fledged solution is implemented.

Member

ewdurbin commented Feb 12, 2018

This is In Progress. Implementing the Delete Docs button is one part, but there is a larger story.

A discussion happened late last year with Read The Docs (RTD) about what a good approach for handling a link between documentation and the package index might be, as warehouse isn't well suited to serve as a documentation host moving forward.

The summary is that post launch, we may be able to implement some sort of handoff to "introduce" a user to RTD for the purposes of authenticating them as valid owners of a namespace on their site that indicates "canonical" package documentation hosting.

Implementing a "redirect" functionality is still up in the air, as it would effectively communicate that we're not going to do anything for package doc hosting moving forward... which hasn't been decided. Although I agree that it would be a good escape hatch in the interim before a more full fledged solution is implemented.

@brainwane

This comment has been minimized.

Show comment
Hide comment
@brainwane

brainwane Mar 8, 2018

Member

Once we have this issue resolved, we should ping @jezdez and @WoLpH to update the sphinx-pypi-upload project & fork (relevant PR) appropriately.

Member

brainwane commented Mar 8, 2018

Once we have this issue resolved, we should ping @jezdez and @WoLpH to update the sphinx-pypi-upload project & fork (relevant PR) appropriately.

@brainwane

This comment has been minimized.

Show comment
Hide comment
@brainwane

brainwane Mar 16, 2018

Member

For context, since I think a few people subscribed to this issue don't know:

Warehouse, the codebase behind the new PyPI, is available as a pre-production site at https://pypi.org . Thanks to limited funding from Mozilla's Open Source Support Program, and it's on its way to replacing the legacy PyPI site by the end of April (roadmap). We're currently seeking feedback from package maintainers, about what does or doesn't work for you in the new interface, and in the next few weeks we'll be doing so with the wider Python developer community.

While the pythonhosted docs/Read the Docs "handoff" can’t really happen until we shut down legacy PyPI, we will be implementing the "delete existing docs" functionality once we (mostly Ernest) have completed the current foundational infrastructure work necessary for the Warehouse switchover. So you'll probably see this within the next six weeks.

I'm sorry for the delay.

Member

brainwane commented Mar 16, 2018

For context, since I think a few people subscribed to this issue don't know:

Warehouse, the codebase behind the new PyPI, is available as a pre-production site at https://pypi.org . Thanks to limited funding from Mozilla's Open Source Support Program, and it's on its way to replacing the legacy PyPI site by the end of April (roadmap). We're currently seeking feedback from package maintainers, about what does or doesn't work for you in the new interface, and in the next few weeks we'll be doing so with the wider Python developer community.

While the pythonhosted docs/Read the Docs "handoff" can’t really happen until we shut down legacy PyPI, we will be implementing the "delete existing docs" functionality once we (mostly Ernest) have completed the current foundational infrastructure work necessary for the Warehouse switchover. So you'll probably see this within the next six weeks.

I'm sorry for the delay.

@brainwane

This comment has been minimized.

Show comment
Hide comment
@brainwane

brainwane Mar 21, 2018

Member

@dstufft said,

We're not allowing new docs to be uploaded in Warehouse, so we'll want people to be able to delete their existing documentation so they can migrate to something else before we shut down legacy.

Does shutting down pypi.python.org also involve shutting down https://www.pythonhosted.org/ and thus making pythonhosted.org documentation (example: https://pythonhosted.org/spyder/help.html ) completely unavailable to users? I presume it does not, in which case, this feature, though deeply needed, does not need to block the shutdown of legacy PyPI.

Member

brainwane commented Mar 21, 2018

@dstufft said,

We're not allowing new docs to be uploaded in Warehouse, so we'll want people to be able to delete their existing documentation so they can migrate to something else before we shut down legacy.

Does shutting down pypi.python.org also involve shutting down https://www.pythonhosted.org/ and thus making pythonhosted.org documentation (example: https://pythonhosted.org/spyder/help.html ) completely unavailable to users? I presume it does not, in which case, this feature, though deeply needed, does not need to block the shutdown of legacy PyPI.

@ewdurbin

This comment has been minimized.

Show comment
Hide comment
@ewdurbin

ewdurbin Mar 25, 2018

Member

once #3413 merges, we should refile a new issue for any redirect behavior that we might envision.

Member

ewdurbin commented Mar 25, 2018

once #3413 merges, we should refile a new issue for any redirect behavior that we might envision.

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