Skip to content

docs: Add project-level import/export specification#7114

Open
khvn26 wants to merge 6 commits intomainfrom
docs/project-scoped-import-export
Open

docs: Add project-level import/export specification#7114
khvn26 wants to merge 6 commits intomainfrom
docs/project-scoped-import-export

Conversation

@khvn26
Copy link
Copy Markdown
Member

@khvn26 khvn26 commented Apr 2, 2026

  • 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 #6761

In this PR, we document the planned project-scoped export/import feature alongside the existing environment-level bulk import/export. This serves as the specification before implementation begins.

Key changes to bulk-import-and-export.md:

  • Extract shared concepts (merge strategy, retention) into a common section to avoid repetition
  • Restructure existing environment-level docs under a clear heading
  • Add new project-level export section documenting:
    • What's always included
    • What's optionally included (identity overrides, tags, custom fields, integrations)
    • What's never included
    • Export format compatibility with environment-level exports
    • Versioning behaviour on import (new versions created in Overwrite Destructive mode)
    • Environment creation behaviour on import

import-and-export.md index page now references both levels.

Preview links

How did you test this code?

Documentation-only change. Verified formatting with npx prettier --check and Vercel preview build.

Document the planned project-scoped export/import feature alongside the
existing environment-level bulk import/export. This serves as the spec
for issue #6761 before implementation begins.

Contributes to #6761

beep boop
@khvn26 khvn26 requested a review from a team as a code owner April 2, 2026 17:51
@khvn26 khvn26 requested review from matthewelwell and removed request for a team April 2, 2026 17:51
Copy link
Copy Markdown

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Code review skipped — your organization's overage spend limit has been reached.

Code review is billed via overage credits. To resume reviews, an organization admin can raise the monthly limit at claude.ai/admin-settings/claude-code.

Once credits are available, reopen this pull request to trigger a review.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 2, 2026

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 3, 2026 4:40pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
flagsmith-frontend-preview Ignored Ignored Preview Apr 3, 2026 4:40pm
flagsmith-frontend-staging Ignored Ignored Preview Apr 3, 2026 4:40pm

Request Review

Prettier was mangling `{/* */}` into `{/_ _/}` which Docusaurus
interprets as a regex literal, breaking the build.

beep boop
- Wrap excluded data list in caution admonition
- Add "How entities are matched" section (by name, not ID)
- Add permission requirements (project admin for export, org admin for import)
- Remove backward-compatibility claim for env-level format in project import

beep boop
Remove custom fields/metadata and integration configurations from the
optional export data table. Neither has schema or serializer support
defined yet. Can be added as follow-up issues.

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

Labels

docs Documentation updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant