Merge pull request #581 from amazonlinux/v0.2.0-docs-changes

v0.2.0 docs changes

START.md

@@ -0,0 +1,10 @@
+# Thar, the Operating System
+
+Welcome to the Thar private preview! Thar is a free and open-source Linux-based operating system meant for hosting containers.
+
+Documentation available on this microsite:
+
+- [README.md](README.md) — Read this first!
+- [INSTALL.md](INSTALL.md#using-a-thar-ami) — Set up a Thar cluster
+- [dogswatch README.md](extras/dogswatch/README.md) — Set up and use the Kubernetes operator for Thar updates
+- [CHANGELOG.md](CHANGELOG.md) — Changes between published versions

tools/gen-docs.sh

@@ -1,13 +1,17 @@
 #!/bin/bash
+DOCS=(START.md README.md INSTALL.md CHANGELOG.md extras/dogswatch/README.md)
+EXTRAS=(extras/dogswatch/{dogswatch,dev/deployment}.yaml)
+
 if ! hash grip; then
  >&2 echo "grip is not installed, run 'pip3 install --user grip'"
  exit 1
 fi
 
 top=$(git rev-parse --show-toplevel)
 mkdir -p "${top}/html"
-for doc in README.md INSTALL.md CHANGELOG.md; do
+for doc in "${DOCS[@]}"; do
  out="${top}/html/${doc%.md}.html"
+ mkdir -p "$(dirname "$out")"
  grip --title="${doc}" --export \
  <(
  cat <<'EOF'
@@ -16,6 +20,8 @@ for doc in README.md INSTALL.md CHANGELOG.md; do
 is via [[email protected]](mailto:[email protected])
 or #thar-preview on the [awsdevelopers Slack workspace](https://awsdevelopers.slack.com) (email us for an invite).
 We'd love to talk with you and hear your feedback on Thar!
+<br><br>
+[&larr; Documentation index](/START.md)
 
 ---
 
@@ -24,8 +30,16 @@ EOF
  ) \
  "${out}"
  sed -i \
- -e '/<link rel="stylesheet".*octicons\.css/d' \
+ -e 's/.*<link rel="stylesheet".*octicons\.css.*/<style>.markdown-body .anchor span:before { font-size: 16px; content: "\\1f517"; }<\/style>/' \
  -e '/<link rel="icon"/d' \
  -e 's/<p>@@THAR-SENTINEL-START@@/<p style="background-color: #a8dfee; border: 1px solid #008296; padding: 1em;">/' \
+ -e 's/<a href="\([^ ">]*\).md/<a href="\1.html/g' \
+ -e 's^<a href="\.\./\.\./pull/[^ ">]*">\(#[0-9]\+\)</a>^\1^g' \
  "${out}"
 done
+
+for extra in "${EXTRAS[@]}"; do
+ out="${top}/html/${extra}"
+ echo "Copying ${extra} to ${out}"
+ install -D "${extra}" "${out}"
+done