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

Can you add redirects #113

Open
afabri opened this issue Apr 24, 2022 · 9 comments
Open

Can you add redirects #113

afabri opened this issue Apr 24, 2022 · 9 comments

Comments

@afabri
Copy link

afabri commented Apr 24, 2022

In the documentation of the CGAL library we have links to unordered map and set. As this has changed we have broken links (see our issue).
Wouldn't it make sense that you add redirections in the .htacess file at https://github.com/boostorg/website/?

@pdimov
Copy link
Member

pdimov commented Apr 24, 2022

@glenfe may suggest a course of action here. Adding per-library things to the global .htaccess doesn't seem the right thing to do. Maybe Unordered should have stub html redirects in its dir.

@albert-github
Copy link

Problem occurs for:

  • unordered
  • utility

@glenfe
Copy link
Member

glenfe commented Apr 25, 2022

Boost as whole only guarantees for a given library or tool that links relative to a specific version will continue to work. These are links relative to doc/libs/VERSION e.g. for Unordered for version 1.78.0 that is doc/libs/1_78_0/doc/html/unordered

i.e. It doesn't guarantee that links relative to libs/unordered or doc/libs/release will continue to work. Individual library authors can guarantee this themselves if they want, but we do not add redirects to .htaccess for this. So Unordered can add HTML files that redirect if they want to preserve compatibility, or they can suggest to users to link to specific versions (not "release" if they plan on breaking those links).

For parts of the Boost website not specific to library documentation, we can add redirects to .htaccess

@cmazakas
Copy link
Member

cmazakas commented Apr 25, 2022

Ideally dependents of Unordered would use versioned links so these kinds of things don't pop up but if you roll with the Boost release, pinning to release makes sense.

It seems like it's pretty straightforward to add a few dummy pages that contain the redirection tag. All we'd have to do is adding something like:

<meta http-equiv="Refresh" content="0; url='https://www.w3docs.com'" />

and this problem should sort itself out.

@afabri
Copy link
Author

afabri commented Apr 26, 2022

I don't know what you mean with pinned links, but we used https://www.boost.org/doc/libs/release/doc/html/boost/unordered_set.html which got redirected correctly for up to boost version 1.78.0. Starting with 1.79 this fails.

@pdimov
Copy link
Member

pdimov commented Apr 26, 2022

Pinned links would mean linking to https://www.boost.org/doc/libs/1_78_0/doc/html/boost/unordered_set.html instead of the latest release.

@afabri
Copy link
Author

afabri commented Apr 26, 2022

But even if we had put 1.78 as pinned version there is something you have to fix:
image
And when you follow the invitation to "click here" this brings you to

image

which is the latest release of boost, but not the package.

@glenfe
Copy link
Member

glenfe commented May 5, 2022

@afabri Yes. We need to have a better solution for things like that.

@pdimov
Copy link
Member

pdimov commented May 6, 2022

In this case it's also that the documentation for Unordered switched from "integrated" to "standalone" so the links changed anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants