Skip to content

Commit

Permalink
gen-docs: Add START.md for private preview docs
Browse files Browse the repository at this point in the history
Signed-off-by: iliana destroyer of worlds <[email protected]>
  • Loading branch information
iliana committed Dec 9, 2019
1 parent 0a17551 commit 7591af0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
10 changes: 10 additions & 0 deletions START.md
Original file line number Diff line number Diff line change
@@ -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) &mdash; Read this first!
- [INSTALL.md](INSTALL.md#using-a-thar-ami) &mdash; Set up a Thar cluster
- [dogswatch README.md](extras/dogswatch/README.md) &mdash; Set up and use the Kubernetes operator for Thar updates
- [CHANGELOG.md](CHANGELOG.md) &mdash; Changes between published versions
6 changes: 4 additions & 2 deletions tools/gen-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ fi

top=$(git rev-parse --show-toplevel)
mkdir -p "${top}/html"
for doc in README.md INSTALL.md CHANGELOG.md extras/dogswatch/README.md; do
for doc in START.md README.md INSTALL.md CHANGELOG.md extras/dogswatch/README.md; do
out="${top}/html/${doc%.md}.html"
mkdir -p "$(dirname "$out")"
grip --title="${doc}" --export \
Expand All @@ -17,6 +17,8 @@ for doc in README.md INSTALL.md CHANGELOG.md extras/dogswatch/README.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)
---
Expand All @@ -28,7 +30,7 @@ EOF
-e '/<link rel="stylesheet".*octicons\.css/d' \
-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="\(.*\).md\(#.*\)\?">/<a href="\1.html\2">/g' \
-e 's^<a href="\.\./\.\./pull/.*">\(#[0-9]\+\)</a>^\1^g' \
"${out}"
done
Expand Down

0 comments on commit 7591af0

Please sign in to comment.