Fix website error pages (apache#13963)

* fix error redirect * add error artifacts for local build
jlcontreras · Feb 14, 2019 · 370a189 · 370a189
1 parent c57da07
commit 370a189
Show file tree

Hide file tree

Showing 9 changed files with 120 additions and 106 deletions.
diff --git a/docs/build_version_doc/artifacts/.htaccess b/docs/build_version_doc/artifacts/.htaccess
@@ -4,7 +4,6 @@ RewriteRule ^get_started/why_mxnet.html$ %{ENV:default_version}/faq/why_mxnet.ht
 RewriteRule ^get_started.*$ %{ENV:default_version}/install/ [R=301,L]
 RewriteRule ^how_to.*$ %{ENV:default_version}/faq/ [R=301,L]
 RewriteRule ^api/python/symbol.html$ %{ENV:default_version}/api/python/symbol/symbol.html [R=301,L]
-RewriteRule ^(?:versions\/[^\/]+\/)?community/index.html$ %{ENV:default_version}/community/contribute.html [R=301,L]
 
 # Navigation bar redirects to latest info
 RewriteCond %{ENV:default_version}#\/$1 !^([^#]+)#\1$
@@ -22,4 +21,4 @@ RewriteRule ^versions/1.0.0/api/clojure/.*$ %{ENV:default_version}/error/api.htm
 RewriteRule ^versions/1.1.0/api/clojure/.*$ %{ENV:default_version}/error/api.html [R=301,L]
 RewriteRule ^versions/1.2.1/api/clojure/.*$ %{ENV:default_version}/error/api.html [R=301,L]
 
-ErrorDocument 404 https://mxnet.incubator.apache.org/error/404.html
+ErrorDocument 404 /error/404.html
diff --git a/docs/build_version_doc/artifacts/404.html b/docs/build_version_doc/artifacts/404.html
@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+<style>
+    { margin: 0; padding: 0; }
+
+    html {
+      background: url('https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-background-compressed.jpeg') no-repeat center center fixed;
+      -webkit-background-size: cover;
+      -moz-background-size: cover;
+      -o-background-size: cover;
+      background-size: cover;
+    }
+
+    h1, p {
+      color: white;
+      font-family: verdana;
+    }
+
+    a:link {
+      color: white;
+    }
+
+    a:visited {
+      color: linen;
+    }
+
+    a:hover {
+      color: powderblue;
+    }
+
+    a:active {
+      color: aqua;
+    }
+
+</style>
+  </head>
+  <body>
+    <div>
+      <a href="/" id="logo" ><img width="200"  src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet_logo.png"></a>
+    </div>
+    <div>
+    <span id="page-does-not-exist"></span><h1>Page Does Not Exist</h1>
+    <p>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 <a href="/">Home Page</a>. Also, make sure you’re looking in the correct version, as some features may only be available in <a href="https://github.com/apache/incubator-mxnet/releases">newer versions</a> or the <a href="/versions/master">master branch</a>.</p>
+    </div>
+  </body>
+</html>
diff --git a/docs/build_version_doc/artifacts/api.html b/docs/build_version_doc/artifacts/api.html
@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+<style>
+    { margin: 0; padding: 0; }
+
+    html {
+      background: url('https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet-background-compressed.jpeg') no-repeat center center fixed;
+      -webkit-background-size: cover;
+      -moz-background-size: cover;
+      -o-background-size: cover;
+      background-size: cover;
+    }
+
+    h1, p {
+      color: white;
+      font-family: verdana;
+    }
+
+    a:link {
+      color: white;
+    }
+
+    a:visited {
+      color: linen;
+    }
+
+    a:hover {
+      color: powderblue;
+    }
+
+    a:active {
+      color: aqua;
+    }
+
+</style>
+  </head>
+  <body>
+    <div>
+      <a href="/" id="logo" ><img width="200"  src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet_logo.png"></a>
+    </div>
+    <div>
+    <span id="page-does-not-exist"></span><h1>API Not Available</h1>
+    <p>You selected an API that is not available for this version of MXNet. Try a more recent version of MXNet, or go the <a href="/versions/master">master branch</a>.</p>
+    </div>
+  </body>
+</html>
diff --git a/docs/build_version_doc/artifacts/index.html b/docs/build_version_doc/artifacts/index.html
diff --git a/docs/build_version_doc/update_all_version.sh b/docs/build_version_doc/update_all_version.sh
@@ -78,20 +78,6 @@ for tag in $tag_list; do
     echo "$tag" >> "$tag_file"
 done
 
-function update_mxnet_css {
-  tag=$1
-  echo "Begin update fixes.."
-  # All fixes are done on the master branch of mxnet-incubator repository
-  # During a nightly build, these fixes will be patched to all the versions in the asf-site repository including the master folder under versions directory.
-  # copy <master folder location> <version folder location>
-
-  echo "Copying mxnet.css from artifacts folder..."
-  cp "artifacts/mxnet.css"  "$built/versions/$tag/_static"
-
-  echo "Update fixes complete.."
-}
-
-
 
 # Update the specified tags with the Versions dropdown
 # Add various artifacts depending on the version
@@ -101,16 +87,6 @@ for tag in $tag_list; do
 
     python AddVersion.py --root_url "$root_url" --file_path "$built/versions/$tag" --current_version "$tag" --tag_default "$tag_default" || exit 1
 
-    # Patch any fixes to all versions except 0.11.0.
-    # Version 0.11.0 has old theme and does not make use of the current mxnet.css
-    # It also has its install page in /getting_started, so we skip updating that
-    if [ $tag != '0.11.0' ]; then
-        if [ -d $built/versions/$tag ]; then
-            echo "The $tag is going to be updated with new css and install pages."
-            update_mxnet_css $tag
-        fi
-    fi
-
     # Update all the files that are required to go into the root folder or live version
     if [ $tag == $tag_default ]
     then

diff --git a/docs/conf.py b/docs/conf.py
@@ -107,7 +107,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['3rdparty', 'api/python/model.md', 'build_version_doc', 'error', 'README.md', 'tutorial_utils', 'virtualenv']
+exclude_patterns = ['3rdparty', 'api/python/model.md', 'build_version_doc', 'README.md', 'tutorial_utils', 'virtualenv']
 
 
 # The reST default role (used for this markup: `text`) to use for all documents.

diff --git a/docs/error/404.md b/docs/error/404.md
diff --git a/docs/error/api.md b/docs/error/api.md
diff --git a/docs/mxdoc.py b/docs/mxdoc.py
@@ -16,6 +16,7 @@
 # under the License.
 
 """A sphnix-doc plugin to build mxnet docs"""
+from __future__ import print_function
 import subprocess
 import re
 import os
@@ -434,6 +435,22 @@ def add_buttons(app, docname, source):
 
         # source[i] = '\n'.join(lines)
 
+
+def copy_artifacts(app):
+    """Copies artifacts needed for website presentation"""
+    print("Copying artifacts...")
+    dest_path = app.builder.outdir + '/error'
+    _run_cmd('cd ' + app.builder.srcdir)
+    _run_cmd('rm -rf ' + dest_path)
+    _run_cmd('mkdir -p ' + dest_path)
+    _run_cmd('cp build_version_doc/artifacts/404.html ' + dest_path)
+    _run_cmd('cp build_version_doc/artifacts/api.html ' + dest_path)
+    dest_path = app.builder.outdir + '/_static'
+    _run_cmd('rm -rf ' + dest_path)
+    _run_cmd('mkdir -p ' + dest_path)
+    _run_cmd('cp _static/mxnet.css ' + dest_path)
+
+
 def setup(app):
     # If MXNET_DOCS_BUILD_MXNET is set something different than 1
     # Skip the build step
@@ -458,6 +475,7 @@ def setup(app):
     if _R_DOCS:
         print("Building R Docs!")
         app.connect("builder-inited", build_r_docs)
+    app.connect("builder-inited", copy_artifacts)
     app.connect('source-read', convert_table)
     app.connect('source-read', add_buttons)
     app.add_config_value('recommonmark_config', {