Skip to content

docs: cohort synchronisation - #8425

Open
Zaimwa9 wants to merge 11 commits into
mainfrom
docs/cohort-synchronisation
Open

docs: cohort synchronisation#8425
Zaimwa9 wants to merge 11 commits into
mainfrom
docs/cohort-synchronisation

Conversation

@Zaimwa9

@Zaimwa9 Zaimwa9 commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Thanks for submitting a PR! Please check the boxes below:

  • I have read the Contributing Guide.
  • I have added information to docs/ if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Contributes to #8420

Adds a Cohort Synchronisation docs category under Third-Party Integrations:

  • Overview — how synchronised segments behave (source owns membership, identifier matching, environment scoping, background updates), where to create one, synchronisation keys, and how to delete a segment or revoke access.
  • CSV file — preparing the file, creating the segment, and re-uploading to update members (each upload replaces the membership).
  • Amplitude — create a synchronisation key, add the Flagsmith cohort destination in Amplitude, then sync a cohort and pick a cadence.

Also updates the connect modal's footer link, which pointed at the generic segments docs, so Amplitude links to its own page and Mixpanel to the category overview.

Mixpanel is intentionally left out of the docs for now and will follow in a separate PR.

How did you test this code?

npm run build in docs/ passes and the Link Check Docs job is green. Screenshots were taken from staging.

@vercel

vercel Bot commented Sep 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Sep 2, 2026 12:04pm UTC
flagsmith-frontend-staging Ready Ready Preview Sep 2, 2026 12:04pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
flagsmith-frontend-preview Ignored Ignored Preview Sep 2, 2026 12:04pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Team

Run ID: c8dee571-0baf-4491-ba15-d86fbf24d4f5

📥 Commits

Reviewing files that changed from the base of the PR and between 0d98e99 and 5353ef9.

📒 Files selected for processing (3)
  • docs/docs/third-party-integrations/cohort-synchronisation/amplitude.md
  • docs/docs/third-party-integrations/cohort-synchronisation/csv-import.md
  • docs/docs/third-party-integrations/cohort-synchronisation/index.md

Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.


📝 Walkthrough

Walkthrough

Adds a new Docusaurus category and three pages for cohort synchronisation. The documentation covers Amplitude synchronisation, CSV import, segment membership replacement, synchronisation keys, and access revocation. Updates CohortProviderConfig with a required docsUrl field. Adds provider-specific URLs for Amplitude and Mixpanel. Updates the connection modal to use the configured URL and new link text.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 5353e

This change adds cohort synchronisation documentation and updates provider help links; no actionable merge-blocking risk remains after normal checks and review.

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot removed the docs Documentation updates label Sep 2, 2026
@github-actions github-actions Bot added the docs Documentation updates label Sep 2, 2026
@Zaimwa9
Zaimwa9 marked this pull request as ready for review September 2, 2026 10:02
@Zaimwa9
Zaimwa9 requested review from a team as code owners September 2, 2026 10:02
@Zaimwa9
Zaimwa9 requested review from talissoncosta and removed request for a team September 2, 2026 10:02
@github-actions github-actions Bot removed the docs Documentation updates label Sep 2, 2026
@Zaimwa9

Zaimwa9 commented Sep 2, 2026

Copy link
Copy Markdown
Contributor Author

@matthewelwell @gagantrivedi would love your feedback on the docs (CSV and Amplitude), available from the vercel docs deployment

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Docker builds report

Image Build Status Security report
ghcr.io/flagsmith/flagsmith-api-test:pr-8425 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-e2e:pr-8425 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-frontend:pr-8425 Finished ✅ Results
ghcr.io/flagsmith/flagsmith:pr-8425 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-api:pr-8425 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-private-cloud:pr-8425 Finished ✅ Results

@github-actions github-actions Bot added the docs Documentation updates label Sep 2, 2026
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor
✅ private-cloud · depot-ubuntu-latest-arm-16 — run #20060 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  39.1 seconds
commit  5353ef9
info  🔄 Run: #20060 (attempt 1)

🗂️ Previous results
✅ private-cloud · depot-ubuntu-latest-16 — run #20060 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  2 passed

Details

stats  2 tests across 2 suites
duration  48.4 seconds
commit  5353ef9
info  🔄 Run: #20060 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #20060 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  39.8 seconds
commit  5353ef9
info  🔄 Run: #20060 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #20060 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  40.4 seconds
commit  5353ef9
info  🔄 Run: #20060 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-arm-16 — run #20059 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  1 minute, 12 seconds
commit  0d98e99
info  🔄 Run: #20059 (attempt 1)

✅ private-cloud · depot-ubuntu-latest-16 — run #20059 (attempt 1)

Playwright Test Results (private-cloud - depot-ubuntu-latest-16)

passed  3 passed

Details

stats  3 tests across 3 suites
duration  33.2 seconds
commit  0d98e99
info  🔄 Run: #20059 (attempt 1)

✅ oss · depot-ubuntu-latest-arm-16 — run #20059 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-arm-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  38 seconds
commit  0d98e99
info  🔄 Run: #20059 (attempt 1)

✅ oss · depot-ubuntu-latest-16 — run #20059 (attempt 1)

Playwright Test Results (oss - depot-ubuntu-latest-16)

passed  1 passed

Details

stats  1 test across 1 suite
duration  34.5 seconds
commit  0d98e99
info  🔄 Run: #20059 (attempt 1)

@github-actions github-actions Bot added the docs Documentation updates label Sep 2, 2026
@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Visual Regression

19 screenshots compared. See report for details.
View full report

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

Labels

docs Documentation updates front-end Issue related to the React Front End Dashboard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant