From af6670d3882506ff3acae98bac0decfc1cc89f3d Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Thu, 30 Aug 2018 22:49:15 +0000 Subject: [PATCH 1/7] consistent theme plus error handling for missing apis and pages --- docs/build_version_doc/artifacts/.htaccess | 6 ++++++ docs/build_version_doc/build_all_version.sh | 1 + 2 files changed, 7 insertions(+) diff --git a/docs/build_version_doc/artifacts/.htaccess b/docs/build_version_doc/artifacts/.htaccess index 5467448f521a..490fff9f571a 100644 --- a/docs/build_version_doc/artifacts/.htaccess +++ b/docs/build_version_doc/artifacts/.htaccess @@ -4,3 +4,9 @@ RewriteRule ^get_started.*$ /install/ [R=301,L] RewriteRule ^how_to.*$ /faq/ [R=301,L] RewriteRule ^api/python/symbol.html$ /api/python/symbol/symbol.html [R=301,L] RewriteRule ^community/index.html$ /community/contribute.html [R=301,L] +RewriteRule ^versions/0.11.0/api/clojure/.*$ /error/api.html [R=301,L] +RewriteRule ^versions/0.12.1/api/clojure/.*$ /error/api.html [R=301,L] +RewriteRule ^versions/1.0.0/api/clojure/.*$ /error/api.html [R=301,L] +RewriteRule ^versions/1.1.0/api/clojure/.*$ /error/api.html [R=301,L] +RewriteRule ^versions/1.2.1/api/clojure/.*$ /error/api.html [R=301,L] +ErrorDocument 404 /error/404.html diff --git a/docs/build_version_doc/build_all_version.sh b/docs/build_version_doc/build_all_version.sh index 350c75b084b7..5f857996f19d 100755 --- a/docs/build_version_doc/build_all_version.sh +++ b/docs/build_version_doc/build_all_version.sh @@ -156,6 +156,7 @@ for key in ${!build_arr[@]}; do cp ../../settings.ini $tag/docs/ cp ../../conf.py $tag/docs/ cp ../../Doxyfile $tag/docs/ + cp -a ../../_static $tag/docs/ echo "Building $tag..." cd $tag/docs From 57433f50160fb0679bc85505aa774dea2ce711b7 Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Fri, 31 Aug 2018 18:38:33 +0000 Subject: [PATCH 2/7] add error pages --- docs/error/404.md | 3 +++ docs/error/api.md | 3 +++ 2 files changed, 6 insertions(+) create mode 100644 docs/error/404.md create mode 100644 docs/error/api.md diff --git a/docs/error/404.md b/docs/error/404.md new file mode 100644 index 000000000000..d64a5c8df7f6 --- /dev/null +++ b/docs/error/404.md @@ -0,0 +1,3 @@ +# Page Removed or Relocated or Never Existed + +If you're here that means you requested a page that doesn't exist. Sorry about that! Maybe try the search box to find what you're looking for. diff --git a/docs/error/api.md b/docs/error/api.md new file mode 100644 index 000000000000..37de50291abd --- /dev/null +++ b/docs/error/api.md @@ -0,0 +1,3 @@ +# API Not Available + +You selected an API that is not available for this version of MXNet. Try a more recent version of MXNet, or go to the [master](../versions/master/) version. From 1603f33736532b4e4b6e5f3ee593426cd4f63e0d Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Tue, 4 Sep 2018 11:14:39 -0700 Subject: [PATCH 3/7] update messaging --- docs/error/404.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/error/404.md b/docs/error/404.md index d64a5c8df7f6..63ebdeb4cbef 100644 --- a/docs/error/404.md +++ b/docs/error/404.md @@ -1,3 +1,3 @@ -# Page Removed or Relocated or Never Existed +# Page Does Not Exist -If you're here that means you requested a page that doesn't exist. Sorry about that! Maybe try the search box to find what you're looking for. +If you're here that means you requested a page that doesn't exist. Sorry about that! Maybe try the search box to find what you're looking for, or navigate to the [Home Page](../index.html). Also, make sure you're looking in the correct version, as some features may only be available in [newer versions](https://github.com/apache/incubator-mxnet/releases) or the [master branch](../versions/master). From e086ed0a798dafbc9c099fe5625cea6467052dce Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Fri, 7 Sep 2018 15:45:26 -0700 Subject: [PATCH 4/7] force url update to 404 page on redirect --- docs/build_version_doc/artifacts/.htaccess | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/build_version_doc/artifacts/.htaccess b/docs/build_version_doc/artifacts/.htaccess index 490fff9f571a..a6bb369117ce 100644 --- a/docs/build_version_doc/artifacts/.htaccess +++ b/docs/build_version_doc/artifacts/.htaccess @@ -9,4 +9,9 @@ RewriteRule ^versions/0.12.1/api/clojure/.*$ /error/api.html [R=301,L] RewriteRule ^versions/1.0.0/api/clojure/.*$ /error/api.html [R=301,L] RewriteRule ^versions/1.1.0/api/clojure/.*$ /error/api.html [R=301,L] RewriteRule ^versions/1.2.1/api/clojure/.*$ /error/api.html [R=301,L] + ErrorDocument 404 /error/404.html + +# Rewrite error redirect URL +RewriteCond %{REQUEST_URI} ^/404/$ +RewriteRule ^(.*)$ /error/404.html [L] From 4337a95f934b836a5f6bee6eb85a225e71e12b0e Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Mon, 10 Sep 2018 13:28:26 -0700 Subject: [PATCH 5/7] static redirect to force url update --- docs/build_version_doc/artifacts/.htaccess | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/build_version_doc/artifacts/.htaccess b/docs/build_version_doc/artifacts/.htaccess index a6bb369117ce..caedabad359a 100644 --- a/docs/build_version_doc/artifacts/.htaccess +++ b/docs/build_version_doc/artifacts/.htaccess @@ -10,8 +10,4 @@ RewriteRule ^versions/1.0.0/api/clojure/.*$ /error/api.html [R=301,L] RewriteRule ^versions/1.1.0/api/clojure/.*$ /error/api.html [R=301,L] RewriteRule ^versions/1.2.1/api/clojure/.*$ /error/api.html [R=301,L] -ErrorDocument 404 /error/404.html - -# Rewrite error redirect URL -RewriteCond %{REQUEST_URI} ^/404/$ -RewriteRule ^(.*)$ /error/404.html [L] +ErrorDocument 404 https://mxnet.incubator.apache.org/error/404.html From b1c424d1ad4bd8e8732be7762ed64dcd2012d054 Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Tue, 11 Sep 2018 16:19:28 -0700 Subject: [PATCH 6/7] version dropdown fix; reverts #12482; lesser of evils --- docs/build_version_doc/AddVersion.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/build_version_doc/AddVersion.py b/docs/build_version_doc/AddVersion.py index 9c5ca9d70406..8f63fc0d16a3 100755 --- a/docs/build_version_doc/AddVersion.py +++ b/docs/build_version_doc/AddVersion.py @@ -75,7 +75,7 @@ navbar.append(version_str) navbar_mobile.append(version_str_mobile) # The following causes rendering errors in code blocks; refer to #12168 - #outstr = str(content).replace('<', '<').replace('>', '>') + outstr = str(content).replace('<', '<').replace('>', '>') # Fix link if args.current_version == tag_list[0]: print("Fixing " + os.path.join(path, name)) @@ -114,4 +114,3 @@ with open(os.path.join(path, name), "w") as outf: outf.write(outstr) - From b50035de0995a0436f1607767ff1d3183af6fcdd Mon Sep 17 00:00:00 2001 From: Aaron Markham Date: Wed, 12 Sep 2018 09:03:57 -0700 Subject: [PATCH 7/7] adding note to nudge past flakey test --- docs/build_version_doc/AddVersion.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build_version_doc/AddVersion.py b/docs/build_version_doc/AddVersion.py index 8f63fc0d16a3..f5e28dfff958 100755 --- a/docs/build_version_doc/AddVersion.py +++ b/docs/build_version_doc/AddVersion.py @@ -74,7 +74,7 @@ version_tag_mobile.extract() navbar.append(version_str) navbar_mobile.append(version_str_mobile) - # The following causes rendering errors in code blocks; refer to #12168 + # The following causes rendering errors in code blocks; refer to #12168 and #12524 outstr = str(content).replace('<', '<').replace('>', '>') # Fix link if args.current_version == tag_list[0]: