Skip to content
Draft
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
58 changes: 58 additions & 0 deletions .github/workflows/azure-static-web-apps-purple-bush-012fe8010.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Azure Static Web Apps CI/CD

on:
push:
branches:
- feature/zensible
pull_request:
types: [opened, synchronize, reopened, closed]
branches:
- feature/zensible

jobs:
build_and_deploy_job:
if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
runs-on: ubuntu-latest
name: Build and Deploy Job
steps:
- uses: actions/checkout@v3
with:
submodules: true
lfs: false
- name: Replace TelemetryDeck App ID
env:
TELEMETRYDECK_APP_ID: ${{ secrets.TELEMETRYDECK_APP_ID }}
run: |
sed -i "s|#TELEMETRYDECK_APP_ID#|${TELEMETRYDECK_APP_ID}|g" overrides/partials/integrations/analytics/telemetrydeck.html
- uses: actions/setup-python@v6
with:
python-version: 3.x
- run: pip install zensical
- run: zensical build --clean
- name: Build And Deploy
id: builddeploy
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PURPLE_BUSH_012FE8010 }}
repo_token: ${{ secrets.GITHUB_TOKEN }} # Used for Github integrations (i.e. PR comments)
action: "upload"
###### Repository/Build Configurations - These values can be configured to match your app requirements. ######
# For more information regarding Static Web App workflow configurations, please visit: https://aka.ms/swaworkflowconfig
app_location: "site"
api_location: ""
skip_app_build: true
skip_api_build: true
output_location: ""
###### End of Repository/Build Configurations ######

close_pull_request_job:
if: github.event_name == 'pull_request' && github.event.action == 'closed'
runs-on: ubuntu-latest
name: Close Pull Request Job
steps:
- name: Close Pull Request
id: closepullrequest
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PURPLE_BUSH_012FE8010 }}
action: "close"
29 changes: 29 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Documentation
on:
push:
branches:
- master
- main
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/configure-pages@v6
- uses: actions/checkout@v6
- uses: actions/setup-python@v6
with:
python-version: 3.x
- run: pip install zensical
- run: zensical build --clean
- uses: actions/upload-pages-artifact@v5
with:
path: site
- uses: actions/deploy-pages@v5
id: deployment
12 changes: 0 additions & 12 deletions docs.11tydata.js

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,9 @@ description: Using the TelemetryDeck API, you can retrieve the query that is use
lead: Using the TelemetryDeck API, you can retrieve the query that is used in an insight
---

{% notewarning "Paid plans only" %}
!!! warning "Paid plans only"

API access — including retrieving an insight's query — is available on TelemetryDeck's paid plans. If your organization is on the free plan, upgrade your plan first and you'll be able to generate a personal access token and use the API.

{% endnotewarning %}
API access — including retrieving an insight's query — is available on TelemetryDeck's paid plans. If your organization is on the free plan, upgrade your plan first and you'll be able to generate a personal access token and use the API.

## Authorization

Expand Down
6 changes: 2 additions & 4 deletions api/api-run-query.md → docs/api/api-run-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ lead: Using the TelemetryDeck API, you can run a query and retrieve its results
order: 2
---

{% notewarning "Paid plans only" %}
!!! warning "Paid plans only"

API access — including running queries — is available on TelemetryDeck's paid plans. If your organization is on the free plan, upgrade your plan first and you'll be able to generate a personal access token and run queries.

{% endnotewarning %}
API access — including running queries — is available on TelemetryDeck's paid plans. If your organization is on the free plan, upgrade your plan first and you'll be able to generate a personal access token and run queries.

## Authorization

Expand Down
6 changes: 2 additions & 4 deletions api/api-token.md → docs/api/api-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,9 @@ lead: To interact with the TelemetryDeck API, you need a personal access token (
order: 1
---

{% notewarning "Paid plans only" %}
!!! warning "Paid plans only"

Personal access tokens are available on TelemetryDeck's paid plans. If your organization is on the free plan, upgrade your plan first and the feature will become available in the dashboard.

{% endnotewarning %}
Personal access tokens are available on TelemetryDeck's paid plans. If your organization is on the free plan, upgrade your plan first and the feature will become available in the dashboard.

## Generating a Personal Access Token

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,12 @@ In the second screen, scroll down until you see the **Identifiers** section.

In TelemetryDeck's **default mode**, with no user identifier specified, check the **Device ID** checkmark. This is what identifies individual users to TelemetryDeck.

{% noteinfo "Other Types of Identifiers" %}
!!! warning "Other Types of Identifiers"

In case you use TelemetryDeck in a more advanced way where you supply a custom user identifier, you'll need to think about this for a second:
In case you use TelemetryDeck in a more advanced way where you supply a custom user identifier, you'll need to think about this for a second:

- If you instead specify a User Identifier such as email address or username to TelemetryDeck, check instead the **User ID** checkmark. The identifier is only transmitted as a hash, but it still counts as a user identifier.
- If you instead are purposefully disabling user tracking by handing the same string to TelemetryDeck for each user, you don't need to check any of the checkboxes in the **Identifiers** section.

{% endnoteinfo %}
- If you instead specify a User Identifier such as email address or username to TelemetryDeck, check instead the **User ID** checkmark. The identifier is only transmitted as a hash, but it still counts as a user identifier.
- If you instead are purposefully disabling user tracking by handing the same string to TelemetryDeck for each user, you don't need to check any of the checkboxes in the **Identifiers** section.

### Usage Data

Expand Down
File renamed without changes.
14 changes: 6 additions & 8 deletions articles/documentation.md → docs/articles/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,16 +79,14 @@ Organizational tags like `docs` and `guides` are automatically applied. Use the
- The experience level of the reader (`beginner`, `intermediate`, `advanced`)
- The type of query (`filter`, `cohorts`, etc.)

{% noteinfo "You don't need to add 'docs' and 'articles' as tags" %}
!!! warning "You don't need to add 'docs' and 'articles' as tags"

All markdown files in the `docs` repository automatically get the `docs` tag applied to them (by `docs.11tydata.js`). In addition, the respective directories apply their own tags as well:
All markdown files in the `docs` repository automatically get the `docs` tag applied to them (by `docs.11tydata.js`). In addition, the respective directories apply their own tags as well:

- Files in the `intro` directory get the `intro` tag applied.
- Files in the `guides` directory get the `guides` tag applied.
- Files in the `articles` directory get the `articles` tag applied.
- Files in the `api` directory get the `api` tag applied.

{% endnoteinfo %}
- Files in the `intro` directory get the `intro` tag applied.
- Files in the `guides` directory get the `guides` tag applied.
- Files in the `articles` directory get the `articles` tag applied.
- Files in the `api` directory get the `api` tag applied.

### Order

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
1 change: 1 addition & 0 deletions docs/assets/favicon.svg
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
31 changes: 31 additions & 0 deletions docs/assets/logo.svg
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
27 changes: 11 additions & 16 deletions guides/javascript-setup.md → docs/guides/javascript-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,15 @@ order: 300

The TelemetryDeck SDK has no dependencies and supports **modern evergreen browsers** and **modern versions of Node.js** with support for [cryptography](https://caniuse.com/cryptography).

{% noteinfo "There are multiple ways of adding TelemetryDeck to a web site" %}
!!! warning "There are multiple ways of adding TelemetryDeck to a web site"

There are different tutorials you should read depending on your use case.
There are different tutorials you should read depending on your use case.

- The [TelemetryDeck Web SDK](/docs/guides/web-setup) is a quick and easy way to include web analytics into your website. This is fantastic for blogs, landing pages, static websites, and content-driven websites.

- If you are building a JavaScript application – a Progressive Web App written in React, Vue, Angular, Svelte, Ember, or mobile or desktop apps written with React Native, Electron, Ionic, and so on, you should read this guide.

[Our blog post](/blog/js-sdk-2-0/) explains the differences between the two SDKs in more detail.

{% endnoteinfo %}
- The [TelemetryDeck Web SDK](/docs/guides/web-setup) is a quick and easy way to include web analytics into your website. This is fantastic for blogs, landing pages, static websites, and content-driven websites.

- If you are building a JavaScript application – a Progressive Web App written in React, Vue, Angular, Svelte, Ember, or mobile or desktop apps written with React Native, Electron, Ionic, and so on, you should read this guide.

[Our blog post](/blog/js-sdk-2-0/) explains the differences between the two SDKs in more detail.

## Set up

Expand Down Expand Up @@ -87,14 +85,11 @@ If can't specify a user identifier at initialization, you can set it later by se

Please note that `td.signal` is an async function that returns a promise.

{% notewarning "Special treatment for frameworks" %}

Some frameworks, like Svelte, don't need `crypto` and node.js. Here are some tips on how to implement TelemetryDeck when using some of these special frameworks:

- The initialization should happen once, and the TD object should be passed around in a service or singleton.
- The `td.send` function should be used to send signals, either automatically in a router-like object or on a per-feature basis.
!!! warning "Special treatment for frameworks"

{% endnotewarning %}
Some frameworks, like Svelte, don't need `crypto` and node.js. Here are some tips on how to implement TelemetryDeck when using some of these special frameworks:
- The initialization should happen once, and the TD object should be passed around in a service or singleton.
- The `td.send` function should be used to send signals, either automatically in a router-like object or on a per-feature basis.

### Advanced initialization options

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 4 additions & 6 deletions guides/web-setup.md → docs/guides/web-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,12 @@ This means that the Web SDK will recognize recurring users on the same day on th

## If you're a developer

{% noteinfo "There are multiple ways of adding TelemetryDeck to a web site" %}
!!! warning "There are multiple ways of adding TelemetryDeck to a web site"

There are different tutorials you should read depending on your use case.
There are different tutorials you should read depending on your use case.

- If you are building a **JavaScript application or PWA using node package manager**, you should read the [Node Package Setup Guide](/docs/guides/javascript-setup).
- If you are building a **website or blog**, and want to include TelemetryDeck with a simple script tag similar to Google Analytics or Plausible Analytics, you should read this guide.

{% endnoteinfo %}
- If you are building a **JavaScript application or PWA using node package manager**, you should read the [Node Package Setup Guide](/docs/guides/javascript-setup).
- If you are building a **website or blog**, and want to include TelemetryDeck with a simple script tag similar to Google Analytics or Plausible Analytics, you should read this guide.

## What to do next

Expand Down
Loading
Loading