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

Missing redirects #24

Closed
mukrop opened this Issue Oct 18, 2017 · 2 comments

Comments

Projects
None yet
3 participants
@mukrop
Copy link

mukrop commented Oct 18, 2017

While doing a larger OpenSSL usability study, we found out that many online man pages that are linked from relevant Stack Overflow threads are inaccessible, since they miss a redirect (which is a pity!).

Specifically, many pages link to commands in this way:

which has a redirect for

However, in the manmaster section, the subsections are no longer apps/ssl/crypto but man1/man3/man5/man7.

Sure, it may not seem that important, but half of the man page links from various internet tutorials our participants (~70 people) wanted to use got them a 404 on OpenSSL pages. Fixing would only require a handful of redirects.

These rewrites would be needed (order matters, since the structure changed):

From To
/docs/manmaster/apps/config.html /docs/manmaster/man5/config.html
/docs/manmaster/apps/x509v3_config.html /docs/manmaster/man5/x509v3_config.html
/docs/manmaster/crypto/bio.html /docs/manmaster/man7/bio.html
/docs/manmaster/crypto/crypto.html /docs/manmaster/man7/crypto.html
/docs/manmaster/crypto/ct.html /docs/manmaster/man7/ct.html
/docs/manmaster/crypto/des_modes.html /docs/manmaster/man7/des_modes.html
/docs/manmaster/crypto/evp.html /docs/manmaster/man7/evp.html
/docs/manmaster/ssl/ssl.html /docs/manmaster/man7/ssl.html
/docs/manmaster/crypto/x509.html /docs/manmaster/man7/x509.html
/docs/manmaster/apps/* /docs/manmaster/man1/*
/docs/manmaster/ssl/* /docs/manmaster/man3/*
/docs/manmaster/crypto/* /docs/manmaster/man3/*

Of the overview manuals (man7), I couldn't find the counterparts of Ed25519.html, RSA-PSS.html, X25519.html and ossl_store.html, but I suspect these were newly written when moving to the manX system.

Another possibility is to redirect things like /docs/apps/rsa.html to a particular version of OpenSSL (e.g. /docs/man1.1.0/apps/rsa.html). This would now require the apps/ssl/crypto to manX translation, but I think it would be unwise to bind on a particular API version.

@kroeckx

This comment has been minimized.

Copy link
Member

kroeckx commented Dec 26, 2017

I think this can be closed?

@richsalz

This comment has been minimized.

Copy link
Contributor

richsalz commented Dec 26, 2017

yes, thanks.

@richsalz richsalz closed this Dec 26, 2017

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