Skip to content

docs: redirect 4.x API doc URLs to 5.x #9396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
faraz152 wants to merge 1 commit into
base: master
Choose a base branch
from
+46 −0
Open

docs: redirect 4.x API doc URLs to 5.x #9396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions deploy_website.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,29 @@ cd $DIR

mv ./build/dokka/htmlMultiModule docs/5.x

# Redirect 4.x doc URLs to 5.x.
# The 4.x API docs were never published to gh-pages, so all /4.x/ URLs 404.
# Since 5.x is the direct successor, redirect there.
mkdir -p docs/4.x
cat > docs/4.x/index.html << 'REDIRECT'
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Redirecting to OkHttp 5.x API docs</title>
<script>
// Redirect /4.x/anything to /5.x/anything
var newPath = window.location.pathname.replace('/4.x/', '/5.x/');
window.location.replace(window.location.origin + newPath + window.location.hash);
</script>
<meta http-equiv="refresh" content="0; url=../5.x/">
</head>
<body>
<p>OkHttp 4.x API docs are no longer published separately. Redirecting to <a href="../5.x/">5.x API docs</a>.</p>
</body>
</html>
REDIRECT

# Copy in special files that GitHub wants in the project root.
cat README.md | grep -v 'project website' > docs/index.md
cp CHANGELOG.md docs/changelogs/changelog.md
Expand Down
23 changes: 23 additions & 0 deletions test_docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,29 @@ set -ex

mv ./build/dokka/html docs/5.x

# Redirect 4.x doc URLs to 5.x.
# The 4.x API docs were never published to gh-pages, so all /4.x/ URLs 404.
# Since 5.x is the direct successor, redirect there.
mkdir -p docs/4.x
cat > docs/4.x/index.html << 'REDIRECT'
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Redirecting to OkHttp 5.x API docs</title>
<script>
// Redirect /4.x/anything to /5.x/anything
var newPath = window.location.pathname.replace('/4.x/', '/5.x/');
window.location.replace(window.location.origin + newPath + window.location.hash);
</script>
<meta http-equiv="refresh" content="0; url=../5.x/">
</head>
<body>
<p>OkHttp 4.x API docs are no longer published separately. Redirecting to <a href="../5.x/">5.x API docs</a>.</p>
</body>
</html>
REDIRECT

# Copy in special files that GitHub wants in the project root.
cat README.md | grep -v 'project website' > docs/index.md
cp CHANGELOG.md docs/changelogs/changelog.md
Expand Down