Skip to content

Commit

Permalink
Refactor layout for 0.1x documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cchantep committed Feb 21, 2018
1 parent 57118fa commit 5ae4784
Show file tree
Hide file tree
Showing 916 changed files with 337 additions and 294 deletions.
10 changes: 6 additions & 4 deletions .ci_scripts/consolidate.sh
Expand Up @@ -6,13 +6,13 @@ do
sed -e 's/java\$lang.html/#java\$lang/g' < "$F" > "$F.tmp" && mv "$F.tmp" "$F"
done

echo "# Generated HTML normalized (for wget compat)"
echo "[INFO] Generated HTML normalized (for wget compat)"

wget -nv -e robots=off --follow-tags=a -r --spider \
-Dlocalhost -Xreleases/0.13/api http://localhost:4000
-Dlocalhost -Xreleases/0.1x/api http://localhost:4000
RES=$?

echo "# Documentation checked for broken links ($RES)"
echo "[INFO] Documentation checked for broken links ($RES)"

rm -rf 'localhost:4000'
pkill -f jekyll
Expand All @@ -22,9 +22,11 @@ if [ $RES -ne 0 ]; then
fi

if [ "x$CI_BRANCH" = "gh-pages" ]; then
echo "# Indexing to Algolia"
echo "[INFO] Indexing to Algolia"
bundle exec jekyll algolia push || (
echo "!! fails to push to Algolia"
false
)
else
echo "[WARN] Skip the Algolia stage: branch = $CI_BRANCH"
fi
4 changes: 2 additions & 2 deletions .ci_scripts/validate.sh
Expand Up @@ -24,7 +24,7 @@ SBT_JAR="$HOME/.sbt/launchers/$SBT_VER/sbt-launch.jar"
(java $SBT_OPTS -jar "$SBT_JAR" compile && \
bundle exec jekyll build) || exit 2

echo "# Spell checking"
echo "[INFO] Spell checking"
./node_modules/markdown-spellcheck/bin/mdspell -r --en-gb -n `find . -not -path '*/node_modules/*' -type f -name '*.md' | perl -pe 's|^\./||;s|[A-Za-z0-9.-]+|*|g' | sort -u | sed -e 's/$/.md/'` '!**/node_modules/**/*.md' '!**/vendor/**/*.md' || exit 3

echo "# Documentation built"
echo "[INFO] Documentation built"
1 change: 1 addition & 0 deletions .spelling
Expand Up @@ -250,3 +250,4 @@ Joline
1125ms
1250ms
10s
0.1x
4 changes: 2 additions & 2 deletions _config.yml
Expand Up @@ -3,7 +3,7 @@ name: "ReactiveMongo"
description: "The reactive Scala driver for MongoDB"
url: http://reactivemongo.org/
markdown: kramdown
latest_major_release: 0.13
latest_major_release: 0.1x
latest_release: 0.13.0
exclude: [vendor,target]
gems:
Expand All @@ -12,7 +12,7 @@ gems:

_0_11_latest_minor: 0.11.14
_0_12_latest_minor: 0.12.6
_0_13_latest_minor: 0.13.0
_0_1x_latest_minor: 0.13.0

algolia:
application_id: 'LZ1F244Z01'
Expand Down
2 changes: 1 addition & 1 deletion _includes/sbt-dependency.md
Expand Up @@ -4,4 +4,4 @@ Using SBT, you just have to edit `build.sbt` and add the driver dependency:
libraryDependencies ++= Seq(
"org.reactivemongo" %% "reactivemongo" % "{{page.major_version}}"
)
{% endhighlight %}
{% endhighlight %}
4 changes: 2 additions & 2 deletions build.sbt
@@ -1,6 +1,6 @@
lazy val release_0_11 = project.in((file(".") / "releases" / "0.11"))

lazy val release_0_13 = project.in((file(".") / "releases" / "0.13"))
lazy val release_0_1x = project.in((file(".") / "releases" / "0.1x"))

lazy val `reactivemongo-site` = (project in file("."))
.settings(
Expand All @@ -13,7 +13,7 @@ lazy val `reactivemongo-site` = (project in file("."))
"org.reactivemongo" %% "reactivemongo" % "0.13.0"),
resolvers ++= Seq(
"Typesafe releases" at "http://repo.typesafe.com/typesafe/releases/"))
.aggregate(release_0_11, release_0_13)
.aggregate(release_0_11, release_0_1x)

organization := "org.reactivemongo"

Expand Down
2 changes: 1 addition & 1 deletion documentation.md
Expand Up @@ -5,7 +5,7 @@ title: Documentation

## Releases

* [**Current stable version ({{site.latest_release}})**](/releases/{{site.latest_major_release}}/documentation/index.html)
* [**Current stable version ({{site.latest_major_release}})**](/releases/{{site.latest_major_release}}/documentation/index.html)
* [Release Notes](/releases/{{site.latest_major_release}}/documentation/release-details.html)
* [Documentation](/releases/{{site.latest_major_release}}/documentation/index.html)
* [Driver API](/releases/{{site.latest_major_release}}/api/index.html)
Expand Down
8 changes: 8 additions & 0 deletions releases/0.12/documentation/advanced-topics/index.html
@@ -0,0 +1,8 @@
<html>
<head>
<title>Redirect</title>
<meta http-equiv="refresh" content="0; url=../0.1x/documentation/advanced-topics" />
<link rel="canonical" href="../0.1x/documentation/advanced-topics" />
</head>
<body></body>
</html>
8 changes: 8 additions & 0 deletions releases/0.12/documentation/bson/index.html
@@ -0,0 +1,8 @@
<html>
<head>
<title>Redirect</title>
<meta http-equiv="refresh" content="0; url=../0.1x/documentation/bson" />
<link rel="canonical" href="../0.1x/documentation/bson" />
</head>
<body></body>
</html>
8 changes: 8 additions & 0 deletions releases/0.12/documentation/index.html
@@ -0,0 +1,8 @@
<html>
<head>
<title>Redirect</title>
<meta http-equiv="refresh" content="0; url=../0.1x/documentation" />
<link rel="canonical" href="../0.1x/documentation" />
</head>
<body></body>
</html>
8 changes: 8 additions & 0 deletions releases/0.12/documentation/json/index.html
@@ -0,0 +1,8 @@
<html>
<head>
<title>Redirect</title>
<meta http-equiv="refresh" content="0; url=../0.1x/documentation/json" />
<link rel="canonical" href="../0.1x/documentation/json" />
</head>
<body></body>
</html>
8 changes: 8 additions & 0 deletions releases/0.12/documentation/tutorial/index.html
@@ -0,0 +1,8 @@
<html>
<head>
<title>Redirect</title>
<meta http-equiv="refresh" content="0; url=../0.1x/documentation/tutorial" />
<link rel="canonical" href="../0.1x/documentation/tutorial" />
</head>
<body></body>
</html>
4 changes: 2 additions & 2 deletions releases/0.12/index.html
@@ -1,8 +1,8 @@
<html>
<head>
<title>Redirect</title>
<meta http-equiv="refresh" content="0; url=../0.13/documentation" />
<link rel="canonical" href="../0.13/documentation" />
<meta http-equiv="refresh" content="0; url=../0.1x/documentation" />
<link rel="canonical" href="../0.1x/documentation" />
</head>
<body></body>
</html>
51 changes: 0 additions & 51 deletions releases/0.13/documentation/tutorial/database-and-collection.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.

0 comments on commit 5ae4784

Please sign in to comment.