Sync docs to website

.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: publish_docs
+
+on:
+  push:
+    branches:
+    - master
+    paths:
+    - 'docs/sources/**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v1
+      - name: Build Website
+        run: |
+          docker run -v ${PWD}/docs/sources:/hugo/content/docs/loki/latest --rm grafana/docs-base:latest /bin/bash -c 'mkdir -p content/docs/grafana/latest/ && touch content/docs/grafana/latest/menu.yaml && make prod'
+  sync:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+    - uses: actions/checkout@v1
+    - run: git clone --single-branch --no-tags --depth 1 -b master https://grafanabot:${{ secrets.GH_BOT_ACCESS_TOKEN }}@github.com/grafana/website-sync ./.github/actions/website-sync
+    - name: publish-to-git
+      uses: ./.github/actions/website-sync
+      id: publish
+      with:
+        repository: grafana/website
+        branch: master
+        host: github.com
+        github_pat: '${{ secrets.GH_BOT_ACCESS_TOKEN }}'
+        source_folder: docs/sources
+        target_folder: content/docs/loki/latest
+    - shell: bash
+      run: |
+        test -n "${{ steps.publish.outputs.commit_hash }}"
+        test -n "${{ steps.publish.outputs.working_directory }}"

.gitignore

@@ -23,3 +23,4 @@ dlv
 rootfs/
 dist
 coverage.txt
+.DS_Store

docs/Makefile

@@ -0,0 +1,11 @@
+IMAGE = grafana/docs-base:latest
+
+.PHONY: docs
+docs:
+	docker pull ${IMAGE}
+	docker run -v ${PWD}/sources:/hugo/content/docs/loki/latest -p 3002:3002 --rm $(IMAGE) /bin/bash -c 'mkdir -p content/docs/grafana/latest/ && touch content/docs/grafana/latest/menu.yaml && make server'
+
+.PHONY: docs-test
+docs-test:
+	docker pull ${IMAGE}
+	docker run -v ${PWD}/sources:/hugo/content/docs/loki/latest -p 3002:3002 --rm $(IMAGE) /bin/bash -c 'mkdir -p content/docs/grafana/latest/ && touch content/docs/grafana/latest/menu.yaml && make prod'

docs/README.md

@@ -1,6 +1,6 @@
 # Loki Documentation
 
-<p align="center"> <img src="logo_and_name.png" alt="Loki Logo"> <br>
+<p align="center"> <img src="sources/logo_and_name.png" alt="Loki Logo"> <br>
   <small>Like Prometheus, but for logs!</small> </p>
 
 Grafana Loki is a set of components that can be composed into a fully featured
@@ -14,50 +14,49 @@ simplifies the operation and significantly lowers the cost of Loki.
 
 ## Table of Contents
 
-1. [Overview](overview/README.md)
-    1. [Comparison to other Log Systems](overview/comparisons.md)
-2. [Installation](installation/README.md)
-    1. [Installing with Tanka](installation/tanka.md)
-    2. [Installing with Helm](installation/helm.md)
-    3. [Installing with Docker](installation/docker.md)
-    4. [Installing locally](installation/local.md)
-3. [Getting Started](getting-started/README.md)
-    1. [Grafana](getting-started/grafana.md)
-    2. [LogCLI](getting-started/logcli.md)
-    3. [Labels](getting-started/labels.md)
-    4. [Troubleshooting](getting-started/troubleshooting.md)
-4. [Best Practices](best-practices/README.md)
-    1. [Current Best Practices](best-practices/current-best-practices.md)
-5. [Configuration](configuration/README.md)
-    1. [Examples](configuration/examples.md)
-6. [Clients](clients/README.md)
-    1. [Promtail](clients/promtail/README.md)
-        1. [Installation](clients/promtail/installation.md)
-        2. [Configuration](clients/promtail/configuration.md)
-        3. [Scraping](clients/promtail/scraping.md)
-        4. [Pipelines](clients/promtail/pipelines.md)
-        5. [Troubleshooting](clients/promtail/troubleshooting.md)
-    2. [Docker Driver](clients/docker-driver/README.md)
-        1. [Configuration](clients/docker-driver/configuration.md)
-    4. [Fluent Bit](../cmd/fluent-bit/README.md)
-    3. [Fluentd](clients/fluentd/README.md)
-7. [LogQL](logql.md)
-8. [Operations](operations/README.md)
-    1. [Authentication](operations/authentication.md)
-    2. [Observability](operations/observability.md)
-    3. [Scalability](operations/scalability.md)
-    4. [Storage](storage.md)
-        1. [Operations](operations/storage/README.md)
-            1. [Table Manager](operations/storage/table-manager.md)
-            2. [Retention](operations/storage/retention.md)
-            3. [BoltDB Shipper](operations/storage/boltdb-shipper.md)
-    5. [Multi-tenancy](operations/multi-tenancy.md)
-    6. [Loki Canary](operations/loki-canary.md)
-9. [HTTP API](api.md)
-10. [Architecture](architecture.md)
-11. [Community](community/README.md)
-    1. [Governance](community/governance.md)
-    2. [Getting in Touch](community/getting-in-touch.md)
-    3. [Contributing to Loki](community/contributing.md)
-12. [Loki Maintainers Guide](./maintaining/README.md)
-    1. [Releasing Loki](./maintaining/release.md)
+1. [Overview](sources/overview/_index.md)
+    1. [Comparison to other Log Systems](sources/overview/comparisons.md)
+2. [Installation](sources/installation/_index.md)
+    1. [Installing with Tanka](sources/installation/tanka.md)
+    2. [Installing with Helm](sources/installation/helm.md)
+    3. [Installing with Docker](sources/installation/docker.md)
+    4. [Installing locally](sources/installation/local.md)
+3. [Getting Started](sources/getting-started/_index.md)
+    1. [Grafana](sources/getting-started/grafana.md)
+    2. [LogCLI](sources/getting-started/logcli.md)
+    3. [Labels](sources/getting-started/labels.md)
+    4. [Troubleshooting](sources/getting-started/troubleshooting.md)
+4. [Best Practices](sources/best-practices/_index.md)
+    1. [Current Best Practices](sources/best-practices/current-best-practices.md)
+5. [Configuration](sources/configuration/_index.md)
+    1. [Examples](sources/configuration/examples.md)
+6. [Clients](sources/clients/_index.md)
+    1. [Promtail](sources/clients/promtail/_index.md)
+        1. [Installation](sources/clients/promtail/installation.md)
+        2. [Configuration](sources/clients/promtail/configuration.md)
+        3. [Scraping](sources/clients/promtail/scraping.md)
+        4. [Pipelines](sources/clients/promtail/pipelines.md)
+        5. [Troubleshooting](sources/clients/promtail/troubleshooting.md)
+    2. [Docker Driver](sources/clients/docker-driver/_index.md)
+        1. [Configuration](sources/clients/docker-driver/configuration.md)
+    4. [Fluent Bit](sources/../cmd/fluent-bit/_index.md)
+    3. [Fluentd](sources/clients/fluentd/_index.md)
+7. [LogQL](sources/logql.md)
+8. [Operations](sources/operations/_index.md)
+    1. [Authentication](sources/operations/authentication.md)
+    2. [Observability](sources/operations/observability.md)
+    3. [Scalability](sources/operations/scalability.md)
+    4. [Storage](sources/operations/storage/_index.md)
+        1. [Table Manager](sources/operations/storage/table-manager.md)
+        2. [Retention](sources/operations/storage/retention.md)
+        3. [BoltDB Shipper](sources/operations/storage/boltdb-shipper.md)
+    5. [Multi-tenancy](sources/operations/multi-tenancy.md)
+    6. [Loki Canary](sources/operations/loki-canary.md)
+9. [HTTP API](sources/api.md)
+10. [Architecture](sources/architecture.md)
+11. [Community](sources/community/_index.md)
+    1. [Governance](sources/community/governance.md)
+    2. [Getting in Touch](sources/community/getting-in-touch.md)
+    3. [Contributing to Loki](sources/community/contributing.md)
+12. [Loki Maintainers Guide](sources/./maintaining/_index.md)
+    1. [Releasing Loki](sources/./maintaining/release.md)

docs/sources/_index.md

@@ -0,0 +1,19 @@
+---
+title: Loki Documentation
+aliases:
+  - /docs/loki/
+---
+
+# Loki Documentation
+
+<p align="center"> <img src="logo_and_name.png" alt="Loki Logo"> <br>
+  <small>Like Prometheus, but for logs!</small> </p>
+
+Grafana Loki is a set of components that can be composed into a fully featured
+logging stack.
+
+Unlike other logging systems, Loki is built around the idea of only indexing
+metadata about your logs: labels (just like Prometheus labels). Log data itself
+is then compressed and stored in chunks in object stores such as S3 or GCS, or
+even locally on the filesystem. A small index and highly compressed chunks
+simplifies the operation and significantly lowers the cost of Loki.