mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
zeekay
1b367e2b62
The tree was a debranded snapshot of upstream taken around 2026-02-20, and upstream has moved about five months since. This replaces it with upstream master, mechanically re-derived: bin/debrand does the rename, and the pipeline and squashed migrations are restored from the shipped tree. Not a merge. The previous import replaced the tree wholesale in a single commit, so there is no shared content history to merge against. Reproducing the rename on the new tree is what actually converges. What survives: .hanzo/workflows, the Dockerfiles and bin/docker* entrypoints, compose files, LLM.md, and insights/migrations. The squashed initial migration is load-bearing — the live database records it by name, so upstream's ~918 individual migrations cannot come back. Nine products are dropped as unreferenced. Twenty-one more that we do not run are kept anyway because the core app still imports them; unpicking those is a refactor and does not belong in a rebase. This base does not build yet, and the reasons are not in the rename: upstream now wants Python 3.13.13 against our 3.12.12 and Django 5.2 against our 4.2, and the dependency manifests still name upstream packages that we republish under our own names. Those are decisions, not renames.
136 lines
6.0 KiB
TypeScript
136 lines
6.0 KiB
TypeScript
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'
|
|
|
|
import { getRubySteps as getRubyStepsPA } from '../product-analytics/ruby'
|
|
import { StepDefinition } from '../steps'
|
|
|
|
export const getRubySteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
|
|
const { CodeBlock, Markdown, dedent, Tab, snippets } = ctx
|
|
const BooleanFlag = snippets?.BooleanFlagSnippet
|
|
const MultivariateFlag = snippets?.MultivariateFlagSnippet
|
|
const OverrideProperties = snippets?.OverridePropertiesSnippet
|
|
|
|
// Get installation steps from product-analytics
|
|
const installationSteps = getRubyStepsPA(ctx)
|
|
|
|
// Add flag-specific steps
|
|
const flagSteps: StepDefinition[] = [
|
|
{
|
|
title: 'Evaluate boolean feature flags',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
Check if a feature flag is enabled:
|
|
`}
|
|
</Markdown>
|
|
{BooleanFlag && <BooleanFlag language="ruby" />}
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Evaluate multivariate feature flags',
|
|
badge: 'optional',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
For multivariate flags, check which variant the user has been assigned:
|
|
`}
|
|
</Markdown>
|
|
{MultivariateFlag && <MultivariateFlag language="ruby" />}
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Include feature flag information in events',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
{dedent`
|
|
If you want to use your feature flag to breakdown or filter events in your insights, you'll need to include feature flag information in those events. This ensures that the feature flag value is attributed correctly to the event.
|
|
|
|
**Note:** This step is only required for events captured using our server-side SDKs or API.
|
|
`}
|
|
</Markdown>
|
|
<Tab.Group tabs={['Set send_feature_flags (recommended)', 'Include $feature property']}>
|
|
<Tab.List>
|
|
<Tab>Set send_feature_flags (recommended)</Tab>
|
|
<Tab>Include $feature property</Tab>
|
|
</Tab.List>
|
|
<Tab.Panels>
|
|
<Tab.Panel>
|
|
<Markdown>
|
|
{dedent`
|
|
Set \`send_feature_flags\` to \`true\` in your capture call:
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'ruby',
|
|
file: 'Ruby',
|
|
code: dedent`
|
|
insights.capture({
|
|
distinct_id: 'distinct_id_of_your_user',
|
|
event: 'event_name',
|
|
send_feature_flags: true,
|
|
})
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
</Tab.Panel>
|
|
<Tab.Panel>
|
|
<Markdown>
|
|
{dedent`
|
|
Include the \`$feature/feature_flag_name\` property in your event properties:
|
|
`}
|
|
</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'ruby',
|
|
file: 'Ruby',
|
|
code: dedent`
|
|
insights.capture({
|
|
distinct_id: 'distinct_id_of_your_user',
|
|
event: 'event_name',
|
|
properties: {
|
|
'$feature/feature-flag-key': 'variant-key', # replace feature-flag-key with your flag key. Replace 'variant-key' with the key of your variant
|
|
}
|
|
})
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
</Tab.Panel>
|
|
</Tab.Panels>
|
|
</Tab.Group>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Override server properties',
|
|
badge: 'optional',
|
|
content: <>{OverrideProperties && <OverrideProperties language="ruby" />}</>,
|
|
},
|
|
{
|
|
title: 'Running experiments',
|
|
badge: 'optional',
|
|
content: (
|
|
<Markdown>
|
|
{dedent`
|
|
Experiments run on top of our feature flags. Once you've implemented the flag in your code, you run an experiment by creating a new experiment in the Insights dashboard.
|
|
`}
|
|
</Markdown>
|
|
),
|
|
},
|
|
]
|
|
|
|
return [...installationSteps, ...flagSteps]
|
|
}
|
|
|
|
export const RubyInstallation = createInstallation(getRubySteps)
|