Skip to content

Add free trial note to Signals tutorial intros - #1884

Open
jborlase-snowplow wants to merge 2 commits into
mainfrom
docs/signals-tutorials-free-trial-note
Open

Add free trial note to Signals tutorial intros#1884
jborlase-snowplow wants to merge 2 commits into
mainfrom
docs/signals-tutorials-free-trial-note

Conversation

@jborlase-snowplow

Copy link
Copy Markdown
Contributor

This PR was generated automatically by Claude.

What changed?

Only 1 of the 8 Signals tutorials mentioned the Snowplow free trial, even though the trial includes Signals. This PR adds an access note to the intro page of the other 7 tutorials, modeled on the one in tutorials/python-tracking-and-signals/introduction.md. Each note is worded to fit the page and ends with the same sentence pointing to the Snowplow free trial.

While editing the intros, "get access" wording was retargeted from /docs/signals/connection/ (the credentials page) to /docs/signals/setup/ (the enable-Signals page):

  • signals-quickstart/start.md: "set up a Signals connection" is now "enable Signals", the "Connecting to Signals" heading is now "Enable Signals", and the "A Signals connection" prerequisite is now "Signals enabled on your Snowplow account"
  • signals-ai-agent-context/introduction.md and signals-google-adk-agent/introduction.md: "Signals deployed" links now point to the setup page as "Signals enabled"
  • signals-ml-prospect-scoring/intro.md: the "Connect to Signals" prerequisite step now says "Enable Signals" and links to the setup page
  • signals-agentic-accelerator/intro.md and signals-personalize-travel/intro.md: existing "Signals enabled" prerequisites now link to the setup page

Why?

The free trial includes Signals, but readers landing on these tutorials without a Snowplow account had no pointer to it. The connection page links sent readers to a credentials page when they actually needed to enable Signals first.

AI reviews

Claude will automatically review this PR against the docs style guide.

If you have questions or want it to look again at something specific, tag @claude in a comment.

🤖 Generated with Claude Code

Add a Snowplow free trial access note to the intro page of the seven
Signals tutorials that were missing one, and retarget "get access"
links from the Signals connection page to the Signals setup page.

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

claude Bot commented Jul 28, 2026

Copy link
Copy Markdown

Docs style review

Scope: writing quality, style guide, terminology, structure, links, MDX components. Nothing technical.

Overall this is a clean, well-targeted change. The /docs/signals/connection//docs/signals/setup/ retarget is right (the setup page is the "enable Signals" page, the connection page is about credentials), tutorial links correctly omit /index.md per the /tutorials exception in CLAUDE.md, and :::note[...] bracket-syntax titles are used consistently. The one external URL added (https://snowplow.io/get-started/snowplow-free-trial) returns 200.

A few things worth fixing:

1. "deploy and use a Snowplow free trial" doesn't fit where the antecedent is an account

tutorials/signals-interventions/start.md:

If you don't have a Snowplow account, you can deploy and use a Snowplow free trial

tutorials/signals-quickstart/start.md:

...so you need a Snowplow account to complete this tutorial. If you don't have one, you can deploy and use a Snowplow free trial

In the note this was modeled on (tutorials/python-tracking-and-signals/introduction.md), "one" refers to a pipeline — "You need a running Snowplow pipeline with Signals enabled. If you don't have one, you can deploy and use..." — so "deploy" reads correctly there. Here the antecedent is an account, which you don't deploy. This is a precision/clarity issue under the style guide's professional-tone guidance (src/pages/style-guide/llm/index.md, "Writing style").

Fix: use "you can sign up for a Snowplow free trial" in these two files. The wording is fine as-is in signals-agentic-accelerator, signals-ai-agent-context, signals-google-adk-agent, signals-ml-prospect-scoring, and signals-personalize-travel, where the antecedent is a pipeline.

2. Each note restates the prerequisite immediately above it

tutorials/signals-quickstart/start.md — the prerequisite list ends with:

  • Signals enabled on your Snowplow account

and the note directly below opens:

Signals calculates attributes from events flowing through your Snowplow pipeline, so you need a Snowplow account to complete this tutorial.

Same pattern in signals-interventions/start.md (the prose above already says "you'll need a Snowplow account with Signals enabled"), and the "...so you need a Snowplow account with Signals enabled" clause repeats an adjacent bullet in signals-ml-prospect-scoring, signals-personalize-travel, and signals-google-adk-agent. The style guide says to remove filler and to use admonitions sparingly (src/pages/style-guide/llm/index.md, "Writing style" and "Markdown formatting").

Fix: drop the restatement clause and let each note carry only what's new — the trial pointer. For example, in the quickstart: "Signals calculates attributes from events flowing through your Snowplow pipeline. If you don't have an account, you can sign up for a Snowplow free trial to follow along." Calling this out once; it applies across the five files listed.

3. Inconsistent link text for the same target

Three files use a state as the link text:

while signals-quickstart and signals-ml-prospect-scoring use the better imperative form ("Enable Signals"). The style guide's Links section says to describe links clearly and use the target page name where possible — the target page is titled "Set up Signals".

Fix: prefer "Enable Signals" or "with Signals enabled (see Set up Signals)" in signals-agentic-accelerator/intro.md, signals-ai-agent-context/introduction.md, signals-google-adk-agent/introduction.md, and signals-personalize-travel/intro.md.

Related, and worth deciding deliberately since this PR is standardizing the wording: tutorials/python-tracking-and-signals/introduction.md still points "[Signals enabled]" at /docs/signals/get-started/ rather than /docs/signals/setup/. If the retarget is meant to be uniform across the Signals tutorials, that one is now the odd one out.

4. Minor

In tutorials/signals-quickstart/start.md, the renamed Enable Signals heading is now echoed by its own body text: "You'll need to enable Signals if you haven't already." Consider "If Signals isn't enabled for your organization yet, follow Set up Signals first."

tutorials/signals-agentic-accelerator/intro.md gains a trailing blank line after the closing :::; worth trimming for consistency with the other six files.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 28, 2026

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 77083c0 Commit Preview URL

Branch Preview URL
Jul 30 2026, 12:58 PM

…ink text

- 'sign up for' where the antecedent is an account (quickstart, interventions)
- notes no longer restate the adjacent prerequisite (5 tutorials)
- imperative/titled link text for /docs/signals/setup/ across intros
- retarget python-tracking-and-signals to /docs/signals/setup/ for uniformity
- quickstart heading echo reworded; stray trailing blank line trimmed

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@jborlase-snowplow

Copy link
Copy Markdown
Contributor Author

Pushed 77083c0b addressing all four style-review items:

  1. "sign up for" replaces "deploy and use" where the antecedent is an account (quickstart, interventions)
  2. The notes no longer restate the adjacent prerequisite — each now carries only the trial pointer (applied across the five flagged files, plus signals-ai-agent-context for consistency with the same pattern)
  3. Link text: (see [Set up Signals](/docs/signals/setup/)) / "[Enable Signals]" imperative forms across the intros — and the flagged decision was taken: python-tracking-and-signals is retargeted from /docs/signals/get-started/ to /docs/signals/setup/ so the retarget is uniform across all Signals tutorials
  4. Quickstart heading echo reworded; trailing blank line trimmed

Build passes (exit 0, links validated).

🤖 Generated with Claude Code

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