Take down docker.github.io #6433

allejo · 2018-04-12T05:15:24Z

Proposed changes

Don't know if you're still interested in taking down the docker.github.io domain from #6101, but see my comment #6101 (comment).

This PR does the following:

Adds a .nojekyll so GitHub doesn't build the site as a Jekyll site
Adds a index.html so GitHub has something to fall back on and it'll redirect to docs.docker.com
Adds index.html to Jekyll's exclude list so it doesn't interfere with index.md
Abuse GitHub's 404.html to blindly attempt a redirect to a docs.docker.com URL

Closes #6101

/cc @joaofnfernandes @thaJeztah

thaJeztah

thanks! I'm not super-familiar with the Jekyll options, but left some comments on the HTML changes 👍

thaJeztah · 2018-04-26T12:30:37Z

index.html

+  <meta http-equiv="refresh" content="0; url=https://docs.docker.com" />
+  <title>Docker docs</title>
+</head>
+<body></body>


Perhaps this body should also mention that we're redirecting; similar to the 404 page, and provide a link if redirect doesn't kick in (e.g., if you're not being automatically redirected, click here ..)

thaJeztah · 2018-04-26T12:31:56Z

404.html

+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Docker docs</title>


nit:perhaps Docker Documentation instead of "docs"

thaJeztah · 2018-04-26T12:32:14Z

index.html

+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="refresh" content="0; url=https://docs.docker.com" />
+  <title>Docker docs</title>


nit:perhaps Docker Documentation instead of "docs"

thaJeztah · 2018-04-26T12:33:52Z

404.html

+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">


Should we have a meta-redirect here as well (perhaps with a 1..2 seconds timeout)?;

<meta http-equiv="refresh" content="1; url=https://docs.docker.com" />

I put it for 1 second as you suggested; should be enough time for JS to kick in if enabled.

thaJeztah · 2018-04-26T12:42:16Z

404.html

+    <p>We have moved away from the <strong>docker.github.io</strong> domain. Please visit <a href="https://docs.docker.com">docs.docker.com</a> instead.</p>
+
+    <script>
+        window.location.replace("https://docs.docker.com" + window.location.pathname);


Not sure we want to remove the original URL from history; perhaps use .assign() instead?

window.location.assign("https://docs.docker.com" + window.location.pathname);

thaJeztah

LGTM, but would like people from the docs team to verify the Jekyll side of things 😅

bermudezmt · 2018-10-04T19:02:50Z

@JustinINevill also sounds like a good candidate for discussion during F2F. See #6101 for more context.

bermudezmt · 2018-12-28T00:54:17Z

@allejo I looked into doing a similar redirect for one of the DTR pages but according to http://www.redirect-checker.org/can-i-use-meta-refresh.php and Wikipedia, the meta refresh tag is deprecated and not recommended by W3C and Google. I do find it concerning that docker.github.io is very out of sync with docs.docker.com. cc: @thaJeztah @JustinINevill

allejo · 2018-12-28T01:21:20Z

Yea, the correct way of handling redirects is using response headers instead of the meta tag or JS. However, GitHub pages doesn’t support anything fancy like response headers. Their recommendation for redirects is the Jekyll redirect plugin, which at its core uses a meta tag refresh.

Unless GitHub support gets involved and starts supporting response redirect support, not sure what other options there are.

GordonTheTurtle · 2018-12-28T06:49:30Z

Deploy preview for docsdocker ready!

Built with commit fef6260

https://deploy-preview-6433--docsdocker.netlify.com

thaJeztah · 2018-12-28T13:02:32Z

Yes, it's definitely a dirty-hack® / band-aid, but I don't think there's another way currently to remove the docker.github.io domain (see the discussion on #6101)

thaJeztah · 2019-01-03T21:55:20Z

@bermudezmt this LGTY?

bermudezmt · 2019-01-04T17:27:54Z

@allejo @thaJeztah what's the least invasive way to test this change? I fiddled around with testing this locally but that doesn't really work. I don't suppose we could point the site URL in _config.yml to staging and test the redirect that way?

allejo · 2019-01-04T17:59:15Z

One idea would be replicating the situation this repo is in:

Create a GH org + gh-pages repo (e.g. sample-org/sample-org.github.io); see the discussion Take docker.github.io down #6101 to make sure I'm not missing anything
Use the master branch to generate this Jekyll site
Then try out this PR in that repo and ensure the redirect works and it no longer builds as a Jekyll site

bermudezmt · 2019-01-04T18:12:39Z

@allejo thank you for the quick response! Sorry if you're having to repeat information regarding this issue (and PR). I will bring this up again at our next team meeting and let you know how we decide to move forward.

bermudezmt · 2019-01-14T22:14:34Z

Status update 01/14/2019:
Conversed with Github and @peter-docker regarding this PR. Here's a thoughtful response from Friday Saarelaht at Github which supports the fixes in this PR, with the caveat that .nojekyll might affect some site configurations:

In the context of GitHub Pages, a "custom domain" refers to any domain other than a GitHub-provided *.github.io subdomain. Looking at the docker/docker.github.io repository, it doesn't appear a custom domain is configured.

If your site is hosted here on GitHub Pages, you can configure docs.docker.com as a custom domain by following our instructions below. If you follow this approach, docker.github.io would then redirect to docs.docker.com automatically.

https://help.github.com/articles/using-a-custom-domain-with-github-pages

However, it doesn't appear docs.docker.com is currently hosted with GitHub Pages. With this in mind, if the goal is to have docker.github.io redirect to an externally-hosted site, then the approach embodied by Pull Request #6433 represent the best available option. It's worth noting that a .nojekyll file disables Jekyll entirely, rendering the _config.yml file changes redundant.

I hope that helps! Let us know if you have any more questions.

Next step is for @JustinINevill to check on current site traffic for docker.github.io.

allejo · 2019-01-14T22:41:19Z

It's worth noting that a .nojekyll file disables Jekyll entirely, rendering the _config.yml file changes redundant.

Just as a note, the .nojekyll file is a GH-pages only feature; it's set so GH won't compile Jekyll and deploy it anymore. The changes to _config.yml are not redundant in this case because there's an index.html in this PR, which will conflict with the current index.md in the repo; index.html will take precedence meaning you'd break the docs.docker.com homepage if you don't ignore it. So when you build the Jekyll site and host it whereever docs.docker.com is currently being hosted, you want Jekyll to build index.md and ignore index.html (which is only intended for GH-pages redirects).

JustinINevill · 2019-01-17T18:44:08Z

@allejo thank you very much for your work on this!

@bermudezmt I'm approving the implementation of this based on your testing and the reduced user confusion that will result from removing this now superfluous, not fully working, and low traffic domain.

bermudezmt · 2019-01-17T19:15:25Z

Thank you so much for your patience with this, @allejo . We welcome more web development / Jekyll insights from you!

Take down docker.github.io

ef4179a

gbarr01 added the area/ux Issue affects functionality of docs.docker.com label Apr 12, 2018

Abuse 404.html to redirect to docs.docker.com

464425f

thaJeztah requested changes Apr 26, 2018

View reviewed changes

Make changes based on feedback

d2d6504

thaJeztah approved these changes Apr 26, 2018

View reviewed changes

bermudezmt requested a review from JustinINevill October 15, 2018 19:33

ghost assigned JustinINevill Dec 21, 2018

Merge branch 'master' into takedown-github-io

fef6260

JustinINevill assigned bermudezmt Jan 14, 2019

bermudezmt merged commit 5af7998 into docker:master Jan 17, 2019

allejo deleted the takedown-github-io branch January 17, 2019 19:30

bermudezmt mentioned this pull request Apr 18, 2019

Revert "Netlify redirects interlock" #8670

Merged

Take down docker.github.io #6433

Take down docker.github.io #6433

Uh oh!

Conversation

allejo commented Apr 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Uh oh!

thaJeztah left a comment

Choose a reason for hiding this comment

Uh oh!

thaJeztah Apr 26, 2018

Choose a reason for hiding this comment

Uh oh!

thaJeztah Apr 26, 2018

Choose a reason for hiding this comment

Uh oh!

thaJeztah Apr 26, 2018

Choose a reason for hiding this comment

Uh oh!

thaJeztah Apr 26, 2018

Choose a reason for hiding this comment

Uh oh!

allejo Apr 26, 2018

Choose a reason for hiding this comment

Uh oh!

thaJeztah Apr 26, 2018

Choose a reason for hiding this comment

Uh oh!

thaJeztah left a comment

Choose a reason for hiding this comment

Uh oh!

bermudezmt commented Oct 4, 2018

Uh oh!

bermudezmt commented Dec 28, 2018

Uh oh!

allejo commented Dec 28, 2018

Uh oh!

GordonTheTurtle commented Dec 28, 2018

Uh oh!

thaJeztah commented Dec 28, 2018

Uh oh!

thaJeztah commented Jan 3, 2019

Uh oh!

bermudezmt commented Jan 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

allejo commented Jan 4, 2019

Uh oh!

bermudezmt commented Jan 4, 2019

Uh oh!

bermudezmt commented Jan 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

allejo commented Jan 14, 2019

Uh oh!

JustinINevill commented Jan 17, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bermudezmt commented Jan 17, 2019

Uh oh!

Uh oh!

allejo commented Apr 12, 2018 •

edited

Loading

bermudezmt commented Jan 4, 2019 •

edited

Loading

bermudezmt commented Jan 14, 2019 •

edited

Loading

JustinINevill commented Jan 17, 2019 •

edited

Loading