Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: switch out using google analytics for posthog support #120

Merged
merged 3 commits into from
Oct 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ on:
paths:
- "docs/**"
- "mkdocs.yml"
workflow_dispatch:
jobs:
build-docs:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -63,7 +64,7 @@ jobs:
config: htmltest.yml

- name: Patch mkdocs.yml Site URL
if: startsWith(github.ref, 'refs/tags/v')
if: startsWith(github.ref, 'refs/tags/v') || ${{ github.event_name == 'workflow_dispatch' }}
uses: jacobtomlinson/gha-find-replace@v2
with:
find: 'site_url: ""'
Expand All @@ -72,7 +73,7 @@ jobs:
include: mkdocs.yml

- name: Patch mkdocs.yml Edit URI
if: startsWith(github.ref, 'refs/tags/v')
if: startsWith(github.ref, 'refs/tags/v') || ${{ github.event_name == 'workflow_dispatch' }}
uses: jacobtomlinson/gha-find-replace@v2
with:
find: 'edit_uri: ""'
Expand All @@ -81,8 +82,7 @@ jobs:
include: mkdocs.yml

- name: Deploy documentation
if: startsWith(github.ref, 'refs/tags/v')
if: startsWith(github.ref, 'refs/tags/v') || ${{ github.event_name == 'workflow_dispatch' }}
env:
GH_TOKEN: ${{ secrets.GH_MKDOCS }}
GH_GOOGLE_ANALYTICS_KEY: ${{ secrets.GH_GOOGLE_ANALYTICS_KEY }}
run: docker run --rm -i -e GH_TOKEN=${GH_TOKEN} -e GH_GOOGLE_ANALYTICS_KEY=${GH_GOOGLE_ANALYTICS_KEY} -v ${PWD}:/docs ghcr.io/purpleclay/mkdocs-material-insiders gh-deploy --force
run: docker run --rm -i -e GH_TOKEN=${GH_TOKEN} -v ${PWD}:/docs ghcr.io/purpleclay/mkdocs-material-insiders gh-deploy --force
8 changes: 8 additions & 0 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{% extends "base.html" %}

{% block extrahead %}
<script>
!function (t, e) { var o, n, p, r; e.__SV || (window.posthog = e, e._i = [], e.init = function (i, s, a) { function g(t, e) { var o = e.split("."); 2 == o.length && (t = t[o[0]], e = o[1]), t[e] = function () { t.push([e].concat(Array.prototype.slice.call(arguments, 0))) } } (p = t.createElement("script")).type = "text/javascript", p.async = !0, p.src = s.api_host + "/static/array.js", (r = t.getElementsByTagName("script")[0]).parentNode.insertBefore(p, r); var u = e; for (void 0 !== a ? u = e[a] = [] : a = "posthog", u.people = u.people || [], u.toString = function (t) { var e = "posthog"; return "posthog" !== a && (e += "." + a), t || (e += " (stub)"), e }, u.people.toString = function () { return u.toString(1) + ".people (stub)" }, o = "capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags".split(" "), n = 0; n < o.length; n++)g(u, o[n]); e._i.push([i, s, a]) }, e.__SV = 1) }(document, window.posthog || []);
posthog.init('phc_Ncp9ZlYYmwQtHRU1t2qwW1JeIduVO1wmWEYiG25oSfN', { api_host: 'https://app.posthog.com' })
</script>
{% endblock %}
1 change: 1 addition & 0 deletions htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ IgnoreDirectoryMissingTrailingSlash: true
IgnoreAltMissing: true
IgnoreInternalEmptyHash: true
ExternalTimeout: 60
CheckDoctype: false
HTTPHeaders:
"Range": "bytes=0-10"
"Accept": "*/*"
3 changes: 1 addition & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ edit_uri: ""

theme:
name: material
custom_dir: docs/overrides
palette:
primary: deep purple
accent: purple
Expand Down Expand Up @@ -57,8 +58,6 @@ extra:
link: https://hub.docker.com/u/purpleclay
name: Purple Clay on Docker Hub
analytics:
provider: google
property: !ENV GH_GOOGLE_ANALYTICS_KEY
feedback:
title: Was this page helpful?
ratings:
Expand Down