docs: update documentation home page

groupe-edf · Dec 14, 2020 · 09e29c4 · 09e29c4
1 parent b99698b
commit 09e29c4
Show file tree

Hide file tree

Showing 7 changed files with 73 additions and 3 deletions.
diff --git a/docs/assets/scss/_styles_project.scss b/docs/assets/scss/_styles_project.scss
@@ -0,0 +1,12 @@
+.td-content {
+  > h1 {
+    color: $secondary
+  }
+}
+.section-index {
+  h5 {
+    a {
+      color: $secondary
+    }
+  }
+}
diff --git a/docs/config.toml b/docs/config.toml
@@ -20,10 +20,19 @@ weight = 1
 
 [markup]
   [markup.goldmark]
+    [markup.goldmark.extensions]
+      definitionList = true
+      table = true
+      typographer = false
     [markup.goldmark.renderer]
       unsafe = true
   [markup.highlight]
-      style = "tango"
+    lineNoStart = 1
+    lineNos = false
+    lineNumbersInTable = true
+    noClasses = true
+    style = "emacs"
+    tabWidth = 2
 
 [params]
 description = ""

diff --git a/docs/content/en/_index.html b/docs/content/en/_index.html
@@ -2,3 +2,14 @@
 title = "Watchdog"
 linkTitle = "Watchdog"
 +++
+
+{{< blocks/cover title="Welcome to Watchdog" image_anchor="top" height="full" >}}
+<div class="mx-auto">
+	<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
+		Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
+	</a>
+	<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/groupe-edf/watchdog">
+		Download <i class="fab fa-github ml-2 "></i>
+	</a>
+</div>
+{{< /blocks/cover >}}
diff --git a/docs/content/en/docs/_index.md b/docs/content/en/docs/_index.md
@@ -7,4 +7,4 @@ menu:
 ---
 Welcome to the Watchdog user guide! This guide shows you how to get started creating custom hooks declaratively using Watchdog.
 
-## What is Watchdog?
+## What is Watchdog?
diff --git a/docs/content/en/docs/deployment/promtail.md b/docs/content/en/docs/deployment/promtail.md
@@ -6,4 +6,25 @@ description: >
   Configuring Promtail.
 ---
 
-Promtail is configured in a YAML file (usually referred to as config.yaml) which contains information on the Promtail server, where positions are stored, and how to scrape logs from files. See `deployments/promtail/watchdog.yaml`
+Promtail is configured in a YAML file (usually referred to as config.yaml) which contains information on the Promtail server, where positions are stored, and how to scrape logs from files.
+
+```yaml
+server:
+  http_listen_port: 9080
+  grpc_listen_port: 0
+
+positions:
+  filename: /tmp/positions.yaml
+
+clients:
+  - url: http://localhost:3100/loki/api/v1/push
+
+scrape_configs:
+- job_name: watchdog
+  static_configs:
+  - targets:
+      - localhost
+    labels:
+      job: watchdog
+      __path__: /var/log/watchdog/watchdog.log
+```
diff --git a/docs/content/en/featured-background.jpg b/docs/content/en/featured-background.jpg
diff --git a/docs/layouts/_default/baseof.html b/docs/layouts/_default/baseof.html
@@ -0,0 +1,17 @@
+<!doctype html>
+<html lang="{{ .Site.Language.Lang }}" class="no-js">
+  <head>
+    {{ partial "head.html" . }}
+  </head>
+  <body class="td-{{ .Kind }}">
+    <header>
+      {{ partial "navbar.html" . }}
+    </header>
+    <div class="container-fluid td-default td-outer">
+      <main role="main" class="td-main">
+        {{ block "main" . }}{{ end }}
+      </main>
+    </div>
+    {{ partialCached "scripts.html" . }}
+  </body>
+</html>