Skip to content

Remove retired Signals Sandbox from hosted notebooks and tutorial templates - #1882

Open
jborlase-snowplow wants to merge 1 commit into
mainfrom
claude/friendly-goldberg-9a2064
Open

Remove retired Signals Sandbox from hosted notebooks and tutorial templates#1882
jborlase-snowplow wants to merge 1 commit into
mainfrom
claude/friendly-goldberg-9a2064

Conversation

@jborlase-snowplow

Copy link
Copy Markdown
Contributor

Summary

The Signals Sandbox was retired and removed from tutorial prose in 9780ee1, but the two hosted notebooks — the primary artifact readers actually run — still contained it, along with the tutorial-requirements templates.

  • static/notebooks/signals-personalize-travel-demo.ipynb: unpinned snowplow-signals (was ==0.4.0), removed the SignalsSandbox import, the sandbox/ACCESS_TOKEN branch, and the Sandbox credentials markdown. The notebook now connects only via Signals(api_url=, api_key=, api_key_id=, org_id=), with variable names (API_URL, API_KEY, API_KEY_ID, ORG_ID) matching tutorials/signals-personalize-travel/defining-attributes.md.
  • static/notebooks/signals-agentic-accelerator.ipynb: removed all 4 SignalsSandbox references (two imports, two constructor branches), the link to the retired https://try-signals.snowplow.io/dashboard, and the Sandbox credentials markdown. The Colab-secret names (SIGNALS_API_URL, SIGNALS_API_KEY, SIGNALS_API_KEY_ID, SIGNALS_ORG_ID, SIGNALS_COLLECTOR_URL) are kept, so tutorials/signals-agentic-accelerator/configure-signals.md was updated to document them alongside the local-run variables.
  • tutorial-requirements/example-tutorial/introduction.md and tutorial-requirements/example-accelerator/introduction.md: removed Sandbox from the "can they use Sandbox, Micro, or Local" guidance (both templates had the same two stale lines).

Before merging

⚠️ Both notebooks should be re-run end to end against a live Signals instance before merge. The Sandbox removal restructures the credential-loading and connection cells, and this change was validated statically (JSON validity, no remaining SignalsSandbox/sandbox/ACCESS_TOKEN references) but not executed against a live deployment.

🤖 Generated with Claude Code

…plates

The Signals Sandbox was retired and removed from tutorial prose in
9780ee1, but the two hosted notebooks still referenced it. Both now
connect only via Signals(api_url=, api_key=, api_key_id=, org_id=),
and the snowplow-signals pip pin (==0.4.0) is removed. The agentic
accelerator tutorial's credentials section now documents the
notebook's Colab secret names. The tutorial-requirements templates no
longer suggest Sandbox as an option.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Missing SEO metadata

The following markdown files are missing required metadata fields:

  • tutorial-requirements/example-accelerator/introduction.md: missing fields: sidebar_label
  • tutorial-requirements/example-tutorial/introduction.md: missing fields: sidebar_label

Required fields

The file metadata is important for SEO and marketing. All markdown files, except for those with filenames starting with _, should include:

  • title: Full, descriptive page title
  • sidebar_label: Short title for navigation sidebar (can be the same as the main title)
  • description: One to two sentences summarizing the page contents
  • keywords: Array of marketing/SEO keywords

Please add the missing metadata.

@claude

claude Bot commented Jul 28, 2026

Copy link
Copy Markdown

Documentation style review

Scope: writing quality, style, terminology, structure, frontmatter, links, and MDX component usage within the diff.

Overall this is a clean, well-scoped removal. The Sandbox removal is consistent — a repo-wide grep for sandbox across docs/signals/, tutorials/, and static/notebooks/ returns no remaining references, so no dangling prose or links are left behind. The consoleConsole corrections bring these files in line with the style guide ("Console: Capitalized, no article"), and [connecting to Signals](/docs/signals/connection/) resolves correctly (/tutorials files are exempt from the /index.md suffix rule per CLAUDE.md).

Three minor items, all in static/notebooks/signals-personalize-travel-demo.ipynb:

1. List introduction is missing a colon

To connect to Snowplow Signals you will need

Style guide, Lists: "Introduce lists with a sentence ending in a colon." The neighboring notebook does this correctly (**Signals credentials:**).

Fix: To connect to Snowplow Signals you will need:

2. Field names not in code formatting

* API_KEY - the API key generated in Console
* API_KEY_ID - the API key ID generated in Console
* ORG_ID - your organization ID from Console (found in the settings page)

CLAUDE.md, Grammar and formatting: "Use backticks for code, file names, and table/field names", and the style guide adds "If the name has underscores, use code formatting." signals-agentic-accelerator.ipynb already does this (SIGNALS_API_KEY), so the two notebooks are now inconsistent with each other.

Fix: wrap the variable names in backticks, so that * API_KEY - the API key generated in Console becomes * `API_KEY` - the API key generated in Console. Applies to the unchanged API_URL item in the same list too, if you are touching it.

3. "collector" should be capitalized

* `SIGNALS_COLLECTOR_URL` - your collector URL

Style guide, Snowplow terminology: "Collector: Capitalized". This line itself was not modified, but the surrounding credentials block was rewritten in this PR (and the duplicate under the removed Sandbox block was deleted), so it is worth fixing while you are in there.

Fix: your Collector URL

Links

No new or modified external URLs to verify — the only added http string is the placeholder https://your-collector.svc.snplow.net inside a Python code block, which is an intentional example value rather than a link, so I did not fetch it.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
documentation 528a658 Commit Preview URL

Branch Preview URL
Jul 28 2026, 04:40 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants