|
4 | 4 | 1. Create a [Scarf account](https://app.scarf.sh/login).
|
5 | 5 | 2. Set up a Scarf Organization for your project. You will see each Organization you belong by clicking on “Organizations” in the top nav or under the dropdown menu at the top right.
|
6 | 6 | 4. Track downloads with Scarf Packages:
|
7 |
| - 1. WHAT IS A PACKAGE: Packages sit in front of downloads creating a redirect (new URL) through the Scarf Gateway to track information about Docker containers, files, npm packages, or Python packages. |
| 7 | + 1. **WHAT IS A PACKAGE:** Packages sit in front of downloads creating a redirect (new URL) through the Scarf Gateway to track information about Docker containers, files, npm packages, or Python packages. |
8 | 8 | 2. Set up a [new package URL](/packages) via the [Scarf Gateway](/gateway) within your Scarf Dashboard.
|
9 | 9 | 4. Point this URL to your current download endpoints.
|
10 |
| - 5. IMPORTANT: Update installation and setup documentation to direct users to use the gateway. |
| 10 | + 5. **IMPORTANT:** Update installation and setup documentation to direct users to use the gateway. |
11 | 11 | 6. Check that the Package is set up properly by the arifact and seeing that it shows up in your Scarf Dashboard.
|
12 | 12 | 5. Documentation and/or website tracking with a Scarf Pixel:
|
13 | 13 | 1. Create a Scarf [Pixel](/web-traffic)
|
14 | 14 | 2. Embed the Pixel in the HTML for the pages you want analytics for (whether on your site or on third-party sites).
|
15 | 15 | 3. Check that the Pixel is loading by opening the page you’ve embedded it on and seeing that it shows up in your Scarf Dashboard.
|
16 | 16 | 6. Link tracking and social monitoring:
|
17 | 17 | 1. Create a new URL in the [Scarf Gateway](/gateway) as a redirect/link shortener to your website, YouTube, Hacker News, or other sites.
|
18 |
| - 2. When posting links on social media, use the new URL instead of the main link. Data will then be available in the Scarf dashboard. |
19 |
| -7. Set up and test basic call home functionality: |
| 18 | + 2. When posting links on social media, use the new Scarf URL instead of the main link. Usage data will then be available in the Scarf Dashboard. |
| 19 | +7. Basic call home functionality: |
20 | 20 | 1. Create a basic URL in [Scarf Gateway](/gateway) that will act as an endpoint for your applications to ping.
|
21 |
| - 2. Point the URL to a blank page on your site. |
22 |
| - 3. In your software, issue an async web call/ping/or page load using (your favorite tool/library/or command, i.e., curl/libcurl, etc.). Note you can call this on start, daily, every time something runs, up to you. You can throw away the result; the mere background call to open the URL is enough. |
| 21 | + 2. Point the Scarf URL to any page you want to track. |
| 22 | + 3. In your software, issue an async web call/ping/or page load using (your favorite tool/library/or command, i.e., curl/libcurl, etc.). **Note:** You can call this on start, daily, every time something runs, up to you. You can throw away the result; the mere background call to open the URL is enough. |
23 | 23 | 8. After testing the various methods you can use to measure downloads, views, and access with Scarf, build a plan for what you want to track and what sort of data you want to see.
|
24 |
| - 1. Roll out tracking to all your projects/sites. |
25 |
| - 2. Update your documentation and tutorials to point to your custom URL. |
26 |
| -9. If you are looking to improve your lead flow, once you have data flowing into your system, fill out the lead generation form and get a trial of leads for your sales team coming directly from your download and web traffic. |
| 24 | + 1. Roll out Scarf tracking to all your projects/sites. |
| 25 | + 2. **Protip:** Update your documentation and tutorials to point to your custom Scarf URL. |
0 commit comments