THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
The website currently has the following redirect patterns that are implemented in a .htaccess file. The source for this file is found in the docs/build_version_docs/artifacts folder.
Using an environment var for the default version, we can flag it throughout the htaccess file:
RewriteRule .* - [E=default_version:/versions/master]
Then we use this variable with:
%{ENV:default_version}
Current Implementation
The first entity is the pattern to match, the second is the destination, and the third is a test URL. Prod for now doesn't use the default version and just redirects to the root.
Our current default version is master. Either way the default version should be recent information. Queries to old pages are redirected.
| Legacy URLs | New URL (desired redirect) | Prod Test URL | Staging Test URL |
|---|---|---|---|
| ^get_started/why_mxnet.html$ | %{ENV:default_version}/faq/why_mxnet.html /versions/master/faq/why_mxnet.html | https://mxnet.incubator.apache.org/get_started/why_mxnet.html | http://34.201.8.176/get_started/why_mxnet.html |
| ^get_started.*$ | %{ENV:default_version}/install/ /versions/master/install/ | https://mxnet.incubator.apache.org/get_started | http://34.201.8.176/get_started |
| ^how_to.*$ | %{ENV:default_version}/faq/ /versions/master/faq/ | https://mxnet.incubator.apache.org/how_to/ | http://34.201.8.176/how_to |
| ^api/python/symbol.html$ | %{ENV:default_version}/api/python/symbol/symbol.html /versions/master/api/python/symbol/symbol.html | https://mxnet.incubator.apache.org/api/python/symbol.html | http://34.201.8.176/api/python/symbol.html |
| ^community/index.html$ | %{ENV:default_version}/community/contribute.html /versions/master/community/contribute.html | https://mxnet.incubator.apache.org/community/index.html | http://34.201.8.176/community/index.html |
The goal for the following section is that any request to a resource of an old version is redirected to the default version.
http://34.201.8.176/architecture should go to http://34.201.8.176/versions/master/architecture
Note that tutorials will carry the request for the particular tutorial over to the default version. Also, since some of the install links can carry a specific install type it might be good to add $1 to that one.
Possible expression to capture the requests listed above and meet the overall goals:
- Make sure requests to "root" resources go to /versions/master/$REQUEST
- Make sure requests to old version resource go to /versions/master/$REQUEST
- Allow requests on /api docs to go to the old version pages
- Search requests on old versions should work
^.*(versions\/[^\/]+)?(?<!master)\/(faq|community|install|gluon|tutorials|architecture)\/(.*)$
Redirect APIs that did not exist
Finally, we have several pages for API that don't exist and it is possible for the user to navigate to them. Instead of a broken page we give them a nice 404 or error message.
^versions/0.11.0/api/python/contrib/onnx.html /error/api.html
^versions/0.12.1/api/python/contrib/onnx.html /error/api.html
^versions/1.0.0/api/python/contrib/onnx.html /error/api.html
^versions/1.1.0/api/python/contrib/onnx.html /error/api.html
Test URL: http://mxnet.incubator.apache.org/versions/0.11.0/api/python/contrib/onnx.html
Test URL: http://34.201.8.176/versions/0.11.0/api/python/contrib/onnx.html
^versions/0.11.0/api/clojure/.*$ /error/api.html
^versions/0.12.1/api/clojure/.*$ /error/api.html
^versions/1.0.0/api/clojure/.*$ /error/api.html
^versions/1.1.0/api/clojure/.*$ /error/api.html
^versions/1.2.1/api/clojure/.*$ /error/api.html
Test URL: http://mxnet.incubator.apache.org/versions/0.11.0/api/clojure/
Test URL: http://34.201.8.176/versions/0.11.0/api/clojure/
Error Pages
ErrorDocument 404 https://mxnet.incubator.apache.org/error/404.html
For all other APIs it should allow the queries to go through.