Website for Thanos' docs using Hugo.

docs/components/query.md

@@ -17,7 +17,7 @@ Querier currently is fully stateless and horizontally scalable.
 $ thanos query \
     --http-address     "0.0.0.0:9090" \
     --store            "<store-api>:<grpc-port>" \
-    --store            "<store-api2>:<grpc-port>" \
+    --store            "<store-api2>:<grpc-port>" 
 ```
 
 ## Deduplication

docs/contributing/how-to-contribute-to-docs.md

@@ -65,4 +65,13 @@ Show new menu section in main page by changing `website/layouts/_default/baseof.
 
 ## Testing
 
-Run `make web-serve` to serve and preview the website locally.
+Run `make web-serve` to serve and preview the website locally.
+
+
+## Deployment.
+
+Ask maintainer to deploy the page. (`GOOGLE_ANALYTICS_TOKEN="<  >" make web-deploy`)
+
+NOTE: It might take couple of seconds to refresh page / CDN for Github pages.
+
+TODO(bwplotka) CI job which does that on every master commit.

docs/proposals/approved/201809_gossip-removal.md

@@ -3,10 +3,10 @@ title: Deprecated gossip clustering in favor of File SD
 type: proposal
 menu: proposals
 status: accepted
-issue: 484
 owner: bwplotka
 ---
 
+### Ticket: https://github.com/improbable-eng/thanos/issues/484
 ## Summary
 
 It is becoming clear that we need to remove gossip protocol as our main way of communication between Thanos Querier and

docs/proposals/approved/201901-read-write-operations-bucket.md

@@ -6,7 +6,7 @@ status: accepted
 owner: bwplotka
 ---
 
-**Tickets:**
+### Tickets:
 
 * https://github.com/improbable-eng/thanos/issues/298 (eventual consistency)
 * https://github.com/improbable-eng/thanos/issues/377 (eventual consistency & partial upload)

docs/service-discovery.md

@@ -45,6 +45,7 @@ The format of the configuration file is the same as the one used in [Prometheus'
 Both YAML and JSON files can be used. The format of the files is this:
 
 * JSON:
+
 ```json
 [
   {
@@ -54,6 +55,7 @@ Both YAML and JSON files can be used. The format of the files is this:
 ```
 
 * YAML:
+
 ```yaml
 - targets: ['localhost:9090', 'example.org:443']
 ```

scripts/websitepreprocess.sh

@@ -16,44 +16,61 @@ mkdir -p ${OUTPUT_CONTENT_DIR}
 # 1. Copy original content.
 cp -r ${ORIGINAL_CONTENT_DIR}/* ${OUTPUT_CONTENT_DIR}
 
-# 2. Copy extra files to content: CODE_OF_CONDUCT.md, CONTRIBUTING.md and CHANGELOG.md files.
+# 2. Add headers to special CODE_OF_CONDUCT.md, CONTRIBUTING.md and CHANGELOG.md files.
 echo "$(cat <<EOT
 ---
 title: Code of Conduct
 type: docs
 menu: contributing
 ---
-
 EOT
-)$(cat CODE_OF_CONDUCT.md)" > ${OUTPUT_CONTENT_DIR}/CODE_OF_CONDUCT.md
+)" > ${OUTPUT_CONTENT_DIR}/CODE_OF_CONDUCT.md
+tail -n +2 CODE_OF_CONDUCT.md >> ${OUTPUT_CONTENT_DIR}/CODE_OF_CONDUCT.md
 
 echo "$(cat <<EOT
 ---
 title: Contributing
 type: docs
 menu: contributing
 ---
-
 EOT
-)$(cat CONTRIBUTING.md)" > ${OUTPUT_CONTENT_DIR}/CONTRIBUTING.md
+)" > ${OUTPUT_CONTENT_DIR}/CONTRIBUTING.md
+tail -n +2 CONTRIBUTING.md >> ${OUTPUT_CONTENT_DIR}/CONTRIBUTING.md
 
 echo "$(cat <<EOT
 ---
 title: Changelog
 type: docs
 menu: thanos
 ---
+EOT
+)" > ${OUTPUT_CONTENT_DIR}/CHANGELOG.md
+tail -n +2 CHANGELOG.md >> ${OUTPUT_CONTENT_DIR}/CHANGELOG.md
+
+ALL_DOC_CONTENT_FILES=`echo "${OUTPUT_CONTENT_DIR}/**/*.md ${OUTPUT_CONTENT_DIR}/*.md"`
+for file in ${ALL_DOC_CONTENT_FILES}
+do
+
+  relFile=${file#*/*/}
+  echo "$(cat <<EOT
+
+---
+
+Found a typo, inconsistency or missing information in our docs?
+Help us to improve [Thanos](https://thanos.io) documentation by proposing a fix [on GitHub here](https://github.com/improbable-eng/thanos/edit/master/${relFile}) :heart:
 
 EOT
-)$(cat CHANGELOG.md)" > ${OUTPUT_CONTENT_DIR}/CHANGELOG.md
+)" >> ${file}
+
+done
 
 # 3. All the absolute links needs are directly linking github with the given commit.
-perl -pi -e 's/]\(\//]\(https:\/\/github.com\/improbable-eng\/thanos\/tree\/'${COMMIT_SHA}'\/docs\//' ${OUTPUT_CONTENT_DIR}/*.md ${OUTPUT_CONTENT_DIR}/**/*.md
+perl -pi -e 's/]\(\//]\(https:\/\/github.com\/improbable-eng\/thanos\/tree\/'${COMMIT_SHA}'\/docs\//' ${ALL_DOC_CONTENT_FILES}
 
 # 4. All the relative links needs to have ../  This is because Hugo is missing: https://github.com/gohugoio/hugo/pull/3934
-perl -pi -e 's/]\(\.\//]\(..\//' ${OUTPUT_CONTENT_DIR}/*.md ${OUTPUT_CONTENT_DIR}/**/*.md
-perl -pi -e 's/]\((?!http)/]\(..\//' ${OUTPUT_CONTENT_DIR}/*.md ${OUTPUT_CONTENT_DIR}/**/*.md
-perl -pi -e 's/src=\"(?!http)/src=\"..\//' ${OUTPUT_CONTENT_DIR}/*.md ${OUTPUT_CONTENT_DIR}/**/*.md
+perl -pi -e 's/]\(\.\//]\(..\//' ${ALL_DOC_CONTENT_FILES}
+perl -pi -e 's/]\((?!http)/]\(..\//' ${ALL_DOC_CONTENT_FILES}
+perl -pi -e 's/src=\"(?!http)/src=\"..\//' ${ALL_DOC_CONTENT_FILES}
 
 # Pass Google analytics token:
 sed -e 's/${GOOGLE_ANALYTICS_TOKEN}/'${GOOGLE_ANALYTICS_TOKEN}'/' ${WEBSITE_DIR}/hugo.tmpl.yaml > ${WEBSITE_DIR}/hugo-generated.yaml

website/layouts/_default/baseof.html

@@ -2,7 +2,8 @@
 <html lang="en">
 
 <head>
-    <meta charset="utf-8">
+    <meta http-equiv="content-type" content="text/html;charset=utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
     <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/css/bootstrap.min.css" integrity="sha384-GJzZqFGwb1QTTN6wy59ffF1BuGJpLSa9DkKMp0DgiMDm4iYMj70gZWKYbI706tWS"
         crossorigin="anonymous">
@@ -79,6 +80,8 @@ <h6 class="font-weight-bold">About</h6>
         crossorigin="anonymous"></script>
     <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js" integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k"
         crossorigin="anonymous"></script>
-    {{ template "_internal/google_analytics_async.html" . }}
+    {{ if eq ( getenv "HUGO_ENV" ) "production" }}
+        {{ template "_internal/google_analytics_async.html" . }}
+    {{ end }}
 </body>
 </html>

website/layouts/_default/sidemenu.html

@@ -8,25 +8,25 @@
     <h5>Thanos</h5>
     <div class="list-group list-group-flush">
         {{ range .Site.Menus.thanos }}
-            <a class="list-group-item list-group-item-action list-group-item-thanos py-1" href="{{ .URL }}">{{ .Title }}</a>
+            <a class="list-group-item list-group-item-action list-group-item-thanos py-1" href="{{ .URL }}">&nbsp;&nbsp;&nbsp;&nbsp;{{ .Title }}</a>
         {{ end }}
     </div>
     <h5 class="mt-3">Components</h5>
     <div class="list-group list-group-flush">
         {{ range .Site.Menus.components }}
-            <a class="list-group-item list-group-item-action list-group-item-thanos py-1" href="{{ .URL }}">{{ .Title }}</a>
+            <a class="list-group-item list-group-item-action list-group-item-thanos py-1" href="{{ .URL }}">&nbsp;&nbsp;&nbsp;&nbsp;{{ .Title }}</a>
         {{ end }}
     </div>
     <h5 class="mt-3">Contributing</h5>
     <div class="list-group list-group-flush">
         {{ range .Site.Menus.contributing }}
-            <a class="list-group-item list-group-item-action list-group-item-thanos py-1" href="{{ .URL }}">{{ .Title }}</a>
+            <a class="list-group-item list-group-item-action list-group-item-thanos py-1" href="{{ .URL }}">&nbsp;&nbsp;&nbsp;&nbsp;{{ .Title }}</a>
         {{ end }}
     </div>
     <h5 class="mt-3">Proposals</h5>
     <div class="list-group list-group-flush">
         {{ range .Site.Menus.proposals }}
-            <a class="list-group-item list-group-item-action list-group-item-thanos py-1" href="{{ .URL }}">{{ .Title }}</a>
+            <a class="list-group-item list-group-item-action list-group-item-thanos py-1" href="{{ .URL }}">&nbsp;&nbsp;&nbsp;&nbsp;{{ .Title }}</a>
         {{ end }}
     </div>
 </nav>

website/layouts/index.html

@@ -43,12 +43,12 @@ <h4 class="font-weight-bold">Unlimited Retention</h4>
         <div class="col-12 col-md-6 col-lg text-center py-5">
             <i class="fas fa-plug fa-5x db mb-3"></i>
             <h4 class="font-weight-bold">Prometheus Compatible</h4>
-            <p>Use the same tools you love such as Grafana or others that supports Prometheus Query API</p>
+            <p>Use the same tools you love such as Grafana or others that supports Prometheus Query API.</p>
         </div>
         <div class="col-12 col-md-6 col-lg text-center py-5">
             <i class="fas fa-file-download fa-5x db mb-3"></i>
             <h4 class="font-weight-bold">Downsampling & Compaction</h4>
-            <p>Downsample historical data for massive query speedup when querying large time ranges or configure complex retention policies</p>
+            <p>Downsample historical data for massive query speedup when querying large time ranges or configure complex retention policies.</p>
         </div>
     </div>
 </div>

website/static/main.css

@@ -12,8 +12,12 @@
     max-width: 100%;
 }
 
-.navbar-dark .navbar-nav .nav-link:hover {
-    color: #ffffff;
+.navbar-dark .navbar-nav .nav-link {
+    color: #fff;
+}
+
+.nav-link:hover {
+    color: rgba(255,255,255,.5)
 }
 
 .btn-outline-secondary {
@@ -38,9 +42,11 @@ pre {
 .list-group-item-thanos {
     color: #6D41FF;
     border: 0;
+    padding: 0;
     background-color: transparent;
 }
 
 .list-group-item-thanos:hover {
     color: #6D41FF;
+    padding: 0;
 }