Skip to content

Commit

Permalink
Add Koala integration (#207)
Browse files Browse the repository at this point in the history
* Add Koala integration

* restaging integration

* fix naming

* Update Koala manifest

* Add boilerplate for script injection

* Add tracking script

* Add script src

* Add logo

* Update package name

* Add changeset

* Add Koala integration to lock file

* Add assets, update manifest, publish

* Remove unused block
  • Loading branch information
addisonschultz authored Jun 24, 2024
1 parent fc4c6dc commit beff5e6
Show file tree
Hide file tree
Showing 11 changed files with 4,560 additions and 3 deletions.
5 changes: 5 additions & 0 deletions .changeset/three-poems-wave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@gitbook/integration-koala': major
---

Initial publish of the koala integration for GitBook
3 changes: 3 additions & 0 deletions integrations/koala/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": ["@gitbook/eslint-config/integration"]
}
Binary file added integrations/koala/assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added integrations/koala/assets/koala-preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions integrations/koala/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: koala
title: Koala
organization: gitbook
visibility: public
description: 'Receive GitBook traffic insights directly in your Koala dashboard.'
icon: ./assets/icon.png
previewImages:
- ./assets/koala-preview.png
summary: |
# Overview
This integration allows you to add the Koala tracker on your published GitBook site.
# How it works
The integration injects the Koala Analytics script on your page, using the configured Koala key, \nso that you can get analytics information from your GitBook site.
# Configure
Install the integration on the GitBook space of your choice.
Locate the Koala key you want to use, which is available in the Koala snippet <pk_xxxxxxxxxxxxxxxxxxx>
externalLinks:
- label: Website
url: https://getkoala.com/
categories:
- analytics
script: src/index.tsx
scopes:
- space:script:inject
- site:script:inject
secrets: {}
contentSecurityPolicy:
script-src: cdn.getkoala.com https://*.getkoala.com;
configurations:
space:
properties:
koala_key:
type: string
title: Koala Key
description: Available in Koala snippet https://cdn.getkoala.com/v1/<pk_xxxxxxxxxxxxxxxxxxx>/sdk.js
required:
- koala_key
site:
properties:
koala_key:
type: string
title: Koala Key
description: Available in Koala snippet https://cdn.getkoala.com/v1/<pk_xxxxxxxxxxxxxxxxxxx>/sdk.js
required:
- koala_key
Loading

0 comments on commit beff5e6

Please sign in to comment.