Opened 3 years ago

Closed 2 years ago

#3530 closed enhancement (fixed)

redirect renamed documentation pages

Reported by: rutsky Owned by: rutsky
Priority: major Milestone: 0.9.4
Version: master Keywords:
Cc:

Description

During "slave"->"worker" transition some documentation pages were renamed, which broke external references on them. Good boys in such cases add redirect from renamed pages to new pages which this issue is about.

There are few possibilities to add redirection.

  1. Using HTML meta refresh with RST meta, e.g.
    .. slave.rst
    
    .. meta::
       :http-equiv=refresh: 0; url=worker.html
    
    Moved to :ref:`Worker`.
    

There are several problems with this approach:

1) It requires to specify (relative) URL to new page, which is different when different builders are used (e.g. html and dirhtml).

2) This is not suited for other than HTML builders (e.g. for PDF).

  1. Using server HTTP redirect.

E.g. via https://github.com/buildbot/buildbot-infra/blob/master/files/www-redirects

and on ReadTheDocs via https://read-the-docs.readthedocs.org/en/latest/user-defined-redirects.html

Looks like last one is the proper approach.

Change History (13)

comment:1 Changed 3 years ago by rutsky

Python Packaging User Guide uses :orphan: and no redirects: https://github.com/pypa/python-packaging-user-guide/blob/master/source/tutorial.rst

:orphan:

This content has moved to the following locations:

* :doc:`installing`
* :doc:`distributing`

comment:2 follow-up: Changed 3 years ago by dustin

  • Milestone changed from undecided to 0.9.0
  • Type changed from undecided to enhancement

I think I saw a PR for this -- is it complete?

comment:3 in reply to: ↑ 2 Changed 3 years ago by rutsky

  • Owner set to rutsky
  • Status changed from new to assigned

Replying to dustin:

I think I saw a PR for this -- is it complete?

Not yet. I pushed renaming for other (not bug #2340 related) page.

comment:5 Changed 3 years ago by dustin

  • Resolution set to fixed
  • Status changed from assigned to closed

merged!

comment:6 Changed 3 years ago by rutsky

  • Resolution fixed deleted
  • Status changed from closed to reopened

I used wrong file for redirection rules, need to properly redo this work.

comment:7 Changed 3 years ago by tardyp

I dont think this should block 0.9.0

comment:8 Changed 3 years ago by tardyp

  • Milestone changed from 0.9.0 to 0.9.1

comment:9 Changed 2 years ago by tardyp

  • Milestone changed from 0.9.1 to 0.9.2

Ticket retargeted after milestone closed

comment:10 Changed 2 years ago by tardyp

  • Milestone changed from 0.9.2 to 0.9.3

Ticket retargeted after milestone closed

comment:11 Changed 2 years ago by tardyp

  • Milestone changed from 0.9.3 to 0.9.4

Ticket retargeted after milestone closed

comment:13 Changed 2 years ago by rutsky

  • Resolution set to fixed
  • Status changed from reopened to closed

Fixed.

Note: See TracTickets for help on using tickets.