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

Documentation Links Broken #265

Open
shkkmo opened this Issue Oct 10, 2018 · 5 comments

Comments

Projects
None yet
3 participants
@shkkmo

shkkmo commented Oct 10, 2018

Many of the links throughout the web to doctrine's documentation have all been broken. This includes a large number of links from blogs and from stackoverflow.

Example:
http://docs.doctrine-project.org/en/latest/reference/advanced-configuration.html

The issue appears to be a re-organization that moved that resource to:

http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/advanced-configuration.html

Instead of showing a "Page not found" error, that resource (and all other moved resources) should provide a 301 redirect response to the new url for that resource.

@jwage

This comment has been minimized.

Member

jwage commented Oct 11, 2018

It is unfortunately not possible to do currently because we use a statically built website and github pages. It might be possible to build a map of redirect rules and do it in javascript though.

@shkkmo

This comment has been minimized.

shkkmo commented Oct 11, 2018

@Majkl578

This comment has been minimized.

Member

Majkl578 commented Oct 21, 2018

Would that work with HTML too? We generate HTML from RST manually and only publish final HTMLs on the GH Pages.

@shkkmo

This comment has been minimized.

shkkmo commented Oct 21, 2018

Yes. The article I linked talks about using a plugin for github page's default static build tool, Jekyll, that generates static pages that use the refresh meta tag as an inferior substitute for a 301 redirect.

I don't know the details of your build process, but having the ability to not break links to documentation seems pretty important.

@Majkl578

This comment has been minimized.

Member

Majkl578 commented Oct 21, 2018

It's important to note that it also includes different subdomain, which may significantly complicate things.
It may be a lot easier to set up static redirects with NGINX for some period. I'll discuss that with @jwage if there is some sane way to get old -> new URL map to set it up.

@Majkl578 Majkl578 transferred this issue from doctrine/common Oct 31, 2018

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