[docs] Document redirects

lautaro-osacar · Mar 11, 2019 · 569595f · 569595f
1 parent 60c16a1
commit 569595f
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -39,6 +39,17 @@ yarn run export-server
 
 You can find the source of the documentation inside the `pages/versions` directory. Documentation is mostly written in markdown with the help of some React components (for Snack embeds, etc). The routes and navbar are automatically inferred from the directory structure within `versions`.
 
+### Redirects
+
+Server-side redirects are re-created on each run of `deploy.sh`.  See that file for 
+
+We currently do two client-side redirects, using meta tags with `http-equiv="refresh"`:
+
+- `/` -> `/versions/latest/`
+- `/versions` -> `/versions/latest`
+
+This method is not great for accessibility and should be avoided where possible.
+
 ### Adding Images and Assets
 
 You can add images and assets to the `static` directory.  They'll be served by the production and staging servers at `/static`.

diff --git a/docs/deploy.sh b/docs/deploy.sh
@@ -16,6 +16,9 @@ aws s3 cp \
 
 declare -A redirects # associative array variable
 
+# usage:
+# redicts[requests/for/this/path]=are/redirected/to/this/one
+
 # Temporarily create a redirect for a page that Home links to
 redirects[versions/latest/introduction/installation.html]=versions/latest/introduction/installation/
 # useful link on twitter