Skip to content

Add public snapshots documentation to notebooks guide #127

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.

Sign up for GitHub

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

Merged
Jeehut merged 2 commits into from
Jul 28, 2025
Merged

Add public snapshots documentation to notebooks guide #127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d19bc2e
Add public snapshots documentation to notebooks guide
Jeehut Jul 26, 2025
00150d9
Add multiple, unpublished, and UUID to Vale vocabulary
Jeehut Jul 28, 2025
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
5 changes: 4 additions & 1 deletion .styles/config/vocabularies/Base/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,7 @@ enum
Onboarding
Anonymization
SDKs
Walkthrough
Walkthrough
multiple
unpublished
UUID
40 changes: 39 additions & 1 deletion articles/notebooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,44 @@
For images, upload them to a service like Imgur or imgbb and use standard markdown image syntax. This is great for adding screenshots, diagrams, or any visual aids to your analysis.
{% endnoteinfo %}

## Sharing your findings: Public Snapshots

Notebooks can be published as public snapshots – shareable reference documents that preserve your findings exactly as they were when you published them.

### How it works

When you publish a notebook, TelemetryDeck creates a **snapshot** that freezes your data at that moment:

1. Click "Publish Snapshot" to make your notebook publicly accessible
2. All TQL queries are processed and results saved into the snapshot
3. Data is frozen – charts show exactly what you saw at publish time
4. You get a unique, private URL that only people with the link can access

{% noteinfo "Private by design" %}
Published snapshots use UUIDs in their URLs and aren't indexed by search engines. Only people you share the link with can access your notebook.

Check failure on line 90 in articles/notebooks.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'UUIDs'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'UUIDs'?", "location": {"path": "articles/notebooks.md", "range": {"start": {"line": 90, "column": 25}}}, "severity": "ERROR"}
{% endnoteinfo %}

### Publishing workflow

- **First publish**: Click "Publish Snapshot" to create your public version
- **Updates**: Button changes to "Update Snapshot" – creates fresh data and replaces the old snapshot
- **Managing**: Use the link icon to visit your public page, "Copy Public Link" to share, or "Unpublish" to remove access

Check failure on line 97 in articles/notebooks.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Unpublish'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Unpublish'?", "location": {"path": "articles/notebooks.md", "range": {"start": {"line": 97, "column": 95}}}, "severity": "ERROR"}
- **Mulitple versions**: Simply "Duplicate" your notebook if to keep the old published analysis and publish the new one when it's ready

Check failure on line 98 in articles/notebooks.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Mulitple'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Mulitple'?", "location": {"path": "articles/notebooks.md", "range": {"start": {"line": 98, "column": 5}}}, "severity": "ERROR"}

### Why snapshots matter

Freezing data ensures your written insights stay meaningful over time. When you reference specific numbers in your analysis, they'll always match the charts – perfect for:

- **Team documentation** that won't become outdated
- **Task requirements** and project briefs with reliable data context
- **Client reports** with consistent, reliable data
- **Reference materials** for future investigations
- **Articles or presentations** where data accuracy matters

{% noteinfo "Live vs. Snapshot Data" %}
Your private notebook editor always shows live, real-time data for ongoing analysis. The public snapshot preserves a point-in-time view for sharing. This gives you both current data for investigation and stable data for communication.
{% endnoteinfo %}

## Putting it all together: a real-world example

Now that we've covered the basics, let's see how notebooks work in practice. We'll walk through an example of analyzing an app's Onboarding flow, showing how notebooks help maintain context long-term.
Expand Down Expand Up @@ -149,7 +187,7 @@
**Long-Running Investigations**:
Perhaps most importantly, notebooks help you maintain momentum during investigations that span weeks or months. Document what you're waiting for, prepare your analysis structure, and dive back in as soon as new data arrives.

Ready to level up your analytics workflow? Open the Notebooks tab and start exploring your data in a more structured, insightful way now!
Ready to level up your analytics workflow? Open the Notebooks tab and start exploring your data in a more structured, insightful way – and share your discoveries with confidence!

## Related resources

Expand Down