Skip to content

Document flat archive structure for import and export #2658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 8, 2025

Conversation

pwizla
Copy link
Collaborator

@pwizla pwizla commented Aug 6, 2025

This PR:

  • documents JSONL archive layout produced by strapi export
  • explains how to inspect and modify exported data before running strapi import

@pwizla pwizla requested a review from meganelacheny as a code owner August 6, 2025 15:39
@pwizla pwizla added the codex label Aug 6, 2025 — with ChatGPT Connector
Copy link

vercel bot commented Aug 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 6, 2025 4:10pm

@pwizla pwizla self-assigned this Aug 6, 2025
@pwizla pwizla added pr: updated content PRs updating existing documentation content source: CMS and removed codex labels Aug 6, 2025
@pwizla pwizla changed the title docs(cms): document flat archive structure for import and export Document flat archive structure for import and export Aug 6, 2025
@pwizla pwizla merged commit 6d059b6 into main Aug 8, 2025
4 checks passed
@pwizla pwizla deleted the codex/documenter-import/export-en-structure-plate branch August 8, 2025 15:22
@pwizla pwizla added this to the 6.6.7 milestone Aug 8, 2025
pwizla added a commit that referenced this pull request Aug 8, 2025
* docs(data-management): document flat archive structure for import and export

* Clarify import/export tables in flat structure

* Add proper next/prev entries to data management pages
pwizla added a commit that referenced this pull request Aug 8, 2025
* docs(data-management): document flat archive structure for import and export

* Clarify import/export tables in flat structure

* Add proper next/prev entries to data management pages
pwizla added a commit that referenced this pull request Aug 13, 2025
* Update deploy-production.yml

* Add link to BC entry for REST API (documentId vs. id)

* Revert "Add link to BC entry for REST API (documentId vs. id)"

This reverts commit 09ba5e4.

* Add link to BC entry for REST API (documentId vs. id)

* Increase modal size to 720px (#2536)

* Add inline prop to custom Badge component (#2538)

* Add very tricky test

* Add inline prop to Badge for tabs edge cases

* Update docusaurus/docs/cms/features/content-type-builder.md

* Add config. parameter to allow Kapa analytics (#2540)

* Expandable card docs wrapper (#2541)

* Add config. parameter to allow Kapa analytics

* Add first draft of ExpandableCardDocsWrapper and use it in U&P docs

* Update CSS to make buttons more subtle

* Update component and style to have icons more aligned with text

* Add tip about Copy Markdown and llms.txt files (#2543)

* Ignore LLMs.txt-related files

* CMS Docs: Conditional Fields (beta release) (#2539)

* Create snippet for conditional fields + Add it in CTB docs

* Fix wording for basic settings

* Add new inline badge

---------

Co-authored-by: Pierre Wizla <[email protected]>

* Bump version to 6.6.0

* Update what's new page with latest AI related options

* Add 6.6.0 release notes

* Add link to blog article about webhooks and Next.js (#2549)

* Add repeatable components/Document Service API breaking change (#2551)

* Add breaking change entry for repeatable components

* Add link to DS API update method ref.

* Add the breaking change

* Fix broken GH worflow by removing llms*.txt files from .gitignore

* Also remove /static from .gitignore

* 🤖 Update LLMs files [skip ci]

* Add link to another REST-related blog post

* [experimental] Add Strapi 12 Rules automated documentation validation (#2556)

* feat: Add Strapi 12 Rules automated documentation validation

- Implement automated style checking based on Strapi's 12 Rules of Technical Writing
- Critical rules block PRs: procedures in numbered lists, no easy/difficult, professional tone
- GitHub Action comments PRs with specific violations and suggestions
- Support for all content, structure, and formatting rules

* Remove workflow file

* Delete docusaurus/docs/test-file.md

* Delete docusaurus/style-check-results.json

* Create documentation-review.yml

* Fix dependency issues in documentation-review.yml

* Improve documentation-review.yml messages

* Add workflow dispatch to documentation-review.yml

* Fix node version requirement in documentation-review.yml

* Fix manual runs (workflow dispatch) implementation of documentation-review.yml

* Create debug-review.yml

* Update validate-content-style.js

* Improve debug-review.yml

* Fix validate-content-style.js with correct paths

* Fix bad argument syntax in documentation-review.yml

* Try to fix file path validation documentation-review.yml

* Fix syntax error in documentation-review.yml

* Fix again syntax error in documentation-review.yml

* Fix yet another syntax error in documentation-review.yml

* Hopefully finally fix documentation-review.yml *cough*

* Try to fix permissions and file path validation in documentation-review.yml

* Update manual dispatch in documentation-review.yml

 to avoid asking the branch

* Fix new error syntax in documentation-review.yml 😅

* Update documentation-review.yml to handle only PR-modified files

* Update validate-content-style.js to handle multiple use cases

* Fix syntax error from prev. commit in documentation-review.yml

and clean up file

* Fix bad SHA issue(s) in documentation-review.yml

* Fix syntax errors from prev. commit in documentation-review.yml

* Ignore React components validation in rule-parser.js

* Increase tolerated number of list items to 5 in style-rules.yml

* Temporarily disable automatic trigger of documentation-review.yml

To prevent frustrating users with an experimental workflow :D

* Fix duplicate header in documentation-review.yml

* Reduce tolerated number of enumerated items in style-rules.yml

* Update package.json

* Update release notes

* Use new notation for accessing plugin config (#2562)

* Fix link to 12 rules in documentation-review.yml

* Create documentation-review-github.yml

* Create gthub-diff-parser.js

* Create validate-content-style-github.js

* Update rule-parser.js

* Update style-rules.yml

* Rename gthub-diff-parser.js to github-diff-parser.js

* Fix resources path in documentation-review-github.yml

* Update style-rules.yml: 3 → 5 items for enumerations

* Use ultra-strict mode for diff parser

* Add local diff test script

* Fix community license link

* Add local/inline test-content.js for PR review automation tests

* Add tmp ignored files during testing phase

* Improve PR QA automation with friendly reporting and inline comments

* Improve validator further

* Create documentation-style-review-enhanced.yml

* Try to fix inline comment posting in documentation-style-review-enhanced.yml

* Fix beta badge color in dark mode

* Remove duplicated sections in Preview docs (#2568)

* 🤖 Update LLMs files [skip ci]

* Improve content validator with better messages and multiple rules handling

* Fix path for ruleParser from prev. commit

* Fix regression from ruleParser commit

* Extract real content for suggestions

* Add debug options for content extraction

* Allow longer quotes in content suggestions

* Improve messaging

* Improve procedures detection in style-rules.yml

* Test upgrading numbered lists issue to critical errors

* Revert "Test upgrading numbered lists issue to critical errors"

This reverts commit 6feea5a.

* Tooltips in TOC (#2561)

* Add tooltip

* Simplify usage

* Remove tooltip test from sidebar

* Get clickable "notice" components that expands upon click

* Convert it to hover effect

* Refine tooltip style further

* Refine tooltip examples in sidebars.js

* Fix styles

* Refine tooltips examples & styles

* Slightly tweak dark mode tooltip styles

* Translate code comment

* Translate code comment

* Add comment on how to use value in HTML notices

* Fix gitignore

* Apply various examples of tooltips to TOC

* Adjust CSS

* Rename properties for HTML type to better handle tooltips

* Fix admin panel custom. tooltip

* 🤖 Update LLMs files [skip ci]

* Remove beta badges (#2554)

* Add release notes for 6.6.2

* Bump to 6.6.2

* Fix Amplitude tracking experiment CDN (#2574)

* chore: put the right tracking experiment cdn

* chore: make the amplitude tracking a plugin

* Cloud: Update content for Canny widget

* fix: broken line breaks in step-by-step file (#2580)

* Update docker.md (#2578)

Corrected strapi network mismatch issues. In docker compose everywhere "strapi" as network has been used but in the last segment where network is explicitly is defined it is written "Strapi" due to which while running docker compose up -d it terminates old container and restricts new container due to network mismatch and then i had to manually delete old container and run new container with new network name.

* Update document-service.md (#2586)

Fix incorrect wording in locale documentation

* Hide second footer (#2588)

* Revert "Hide second footer (#2588)"

This reverts commit 86daad3.

* Hide second footer (#2589)

* Re-fix duplicate footer 😅

* Add release notes for 6.6.3

* Bump to 6.6.3

* Add mention about building in QSG (#2590)

* Fix color for highlighted code lines

* Document release statuses in Releases feature page

* Expand strapi generate documentation (#2593)

* Add ExpandableContent component

* Augment strapi generate CLI docs & use ExpandableContent component

* Ensure collapsing content scrolls back to button

* Improve ExpandableComponent design

* Improve formatting

* Add GIF

* 🤖 Update LLMs files [skip ci]

* Improve strapi-generate docs further (#2595)

Expands upon PR #2593

* Be slightly more specific in content-types config. options for generate

* Document pluginOptions in Models

* Rework pluginOptions table

* Fix mistake in pluginOptions descriptions in table

* Add subscription cancellation section in Cloud Billing & Usage docs

* Add details about strapi.console

* Add callout about overriding image function in Plugins extension docs

* Add callout in Media Library doc to redirect users to the plugin extension doc

* Stop tracking llms-full.txt

* Initialization section updates

Clearer examples and addition of error message if baseURL is missing protocol

* Update Authentication section

Added note that this is the only auth method currently; added error message

* Ditched [source] 

Standardising with rest of docs

* Upload file additions

* chore: update Strapi Cloud settings screenshots (#2585)

* Docusaurus improvements

* Fix formatting

* Revert "Fix formatting"

This reverts commit edd788d.

* Draft documentation for new transfer ownership feature

* Remove LLMS-full.txt

* Remove LLMS-full.txt

* Improve structure

so that the new upload-related information better fits with the
existing information architecture

* Update version in package.json

* Update release notes

* Fix broken anchors

* re-add llms-full.txt

* 🤖 Update LLMs files [skip ci]

* Fix tabs display with long labels (#2605)

* Add tabs--allow-multiline class to handle tabs with long labels

* Use it on document concept page

* Quickly update the Preview docs to mention Desktop/Mobile switch (#2607)

* 🤖 Update LLMs files [skip ci]

* Fix MermaidWithFallback diagram display (#2609)

was not properly loading diagrams when switching tabs

* Update docusaurus/docs/cms/api/client.md

Co-authored-by: Jamie Howard <[email protected]>

* Update docusaurus/docs/cms/api/client.md

Co-authored-by: Jamie Howard <[email protected]>

* Reverted authentication info change

U&P is usable now (but still not documented here)

* Review comments

* Update formatting (no title case)

* Use proper ExternalLink component for link to source code

* Improve and complete transfer ownership doc

* Better explain the move to `documentId` (#2604)

* Expand Document Service API introduction

* Improve formatting for additional resources in breaking change page

* Fine-tune introduction wording

* Mention why using documentId is recommended

* 🤖 Update LLMs files [skip ci]

* 🤖 Update LLMs files [skip ci]

* Async project creation on Strapi Cloud (#2581)

* chore: updated account repository selection images

* feat: documentation for async project creation

* feat: documentation for async environment creation

* Apply suggestions from code review

Co-authored-by: Pierre Wizla <[email protected]>

---------

Co-authored-by: Pierre Wizla <[email protected]>

* 🤖 Update LLMs files [skip ci]

* Improve transfer ownership docs to mention the possibility to request ownership as maintainer

* Explain there's only one GraphQL endpoint and how to customize its URL (#2617)

* Explain there's only one GraphQL endpoint and how to customize its URL

* Fix tone

* Mention DS API findOne returns null if no document found (#2614)

* GraphQL & REST API: more information on operators & more examples (#2615)

* Add simple examples + improve existing example for GraphQL API filters

* remove TODO comment

* Show more simple GraphQL examples by default

* Add more information on filters in REST API

* Make complex REST API example for complex

* Try other formatting for GraphQL API examples

* Go back to previous formatting for GraphQL API simple examples

* Document missing eqi and nei operators for GraphQL API

* 🤖 Update LLMs files [skip ci]

* Improve GraphQL queries explanations (Flat vs. Relay-style) (#2621)

* docs: expand v5 migration info

* Use caution callout instead of note

* Remove unwanted added note about upgrading

* Add blank line

* Add blank line

* Ensure code blocks are properly indented in instructions

* Add link to documentId breaking change

* Increase timeout of auto-respond-issues.yml

* Update screenshots

* Fix content

* Bump version to 6.6.5

* Add release notes for 6.6.5

* Update admin panel doc to add new 'Reset guided tour' setting (#2612)

* 🤖 Update LLMs files [skip ci]

* feat: documentation for download backup (#2582)

* 🤖 Update LLMs files [skip ci]

* Add precisions on transfer ownership

* Add badges

* Fix another issue

* 🤖 Update LLMs files [skip ci]

* Add experimental firstPublishedAt configuration (#2636)

* docs: add firstPublishedAt future flag

* Move paragraph to config. heading and add cross-link

* Fix 'v4CompatibilityMode' typo for Strapi 5 migration (#2635)

* fix typo

* fix typo

* 🤖 Update LLMs files [skip ci]

* Update step-by-step.md (#2640)

* 🤖 Update LLMs files [skip ci]

* Fix typo in features config. example

* Improve environment variables page (#2639)

* docs: add sample env file and link

* Update docusaurus/docs/cms/deployment.md

* Update sample-env.md

* Update environment.md

* Update sample-env.md

* Update sample-env.md

* Reformat

* Add heading for easier linking

* Add links to feature pages

* Fix anchor link

* Add advanced queries and policies guides to GraphQL docs (#2634)

* Add advanced queries and policies guides to GraphQL docs

* Update titles in YAML cartridge

* Improve PostgreSQL database config. example (#2643)

* docs: clarify content manager panel api (#2646)

* Improve backend service docs (#2648)

* Add note in Server config doc about keep alive configuration (#2645)

* 🤖 Update LLMs files [skip ci]

* Add release notes for 6.6.6

* Add callout in database config with precisions on data.db path (#2655)

* Clarify `database` vs. `filename` usage in database configuration (#2657)

* Add release notes for 6.6.6

* Clarify `database` vs. `filename` depending on database type

Useful with #2655

* Bump version to 6.6.6

* Update release notes

* Add missing word to release numbers explanations

* docs: update controller sanitization (#2661)

* 🤖 Update LLMs files [skip ci]

* Update functions.md (#2660)

Correct small mistake bootstrapi() -> bootstrap()

* 🤖 Update LLMs files [skip ci]

* Fix unwanted blank space

* 🤖 Update LLMs files [skip ci]

* Fix no search results for `db.query` (#2667)

* Update APIs introduction so db.query now appears in search results

* Ensure prerequisites are shown on each page

* Document flat archive structure for import and export (#2658)

* docs(data-management): document flat archive structure for import and export

* Clarify import/export tables in flat structure

* Add proper next/prev entries to data management pages

* Improve copy of db.query in Content API intro.

This improves upon PR #2667

* 🤖 Update LLMs files [skip ci]

* Update EOS date

* Update old caution

* 🤖 Update LLMs files [skip ci]

* Fix missing blank lines

* Fix LLMs.txt

* Add example questions to Kapa AI modal

* Add DebugComponent

* Add first skeleton of AiToolbar component and its logic

* Add Copy Markdown button logic and style and test it on CMS intro page

* Improve button styles

* Swizzle heading component to include AiToolbar in all h1s

* Add LLMs buttons

* Fix dark mode

* Remove Copy Markdown button from secondary TOC

* Remove LLM txt files from footer

* Move AiToolbar to left

* Add special hook to ensure badges are displayed before AiToolbar

* Add missing h1s to some pages

so that the AiToolbar is displayed, because it's part of headings

* Fix margin around badges container

* Add description to hook

* Open API spec generation (#2665)

* Open API spec generation

* Update docusaurus/docs/cms/api/openapi.md

Co-authored-by: Jamie Howard <[email protected]>

* Update docusaurus/docs/cms/api/openapi.md

Co-authored-by: Jamie Howard <[email protected]>

* Rework the Open API file

* Improve CLI entry

* Add it to What's new? page

* Add it to sidebar

* Update LLMs-full.txt

* Add screenshot

* Add info. about contrib. docs

* Improve copy

* Add example file

* Fix tabs formatting

* Fix title casing

* Move CLI entry docs higher

* Clarify a heading

* Fix tags

* Wrap example in ExpandableContent component

* Shorten intro.

* Add more links to middlewares config. docs

* Clarify intro

* Fix casing of labels for a yarn/npm tabs group

---------

Co-authored-by: Jamie Howard <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>
Co-authored-by: Pierre Wizla <[email protected]>

* 🤖 Update LLMs files [skip ci]

* Update Admin Panel and Homepage customization pages with new widgets and new guided tour UI (#2671)

* Fix missing blank lines

* Update admin panel and homepage customization pages with new UI

* v6.7.0

* Implement first version

* Revise approach and include Ask AI button in existing button group

* Refine style, pt. 1

* Refine style, pt. 2

* Increase Kapa modal size

* Increase Kapa modal size

* Remove unused files

* Also remove unused ContextualizedAIButton code

since we simplified the architecture and only "swizzle" the
default Code block from Docusaurus 3.x

* Add comment to test Vercel deploy

* Update yarn.lock

* Update LLMs txt files

---------

Co-authored-by: meganelacheny <[email protected]>
Co-authored-by: GitHub Actions <[email protected]>
Co-authored-by: unrevised6419 <[email protected]>
Co-authored-by: Tung Nguyen <[email protected]>
Co-authored-by: Maxime Castres <[email protected]>
Co-authored-by: mariekirsch <[email protected]>
Co-authored-by: ndaemy <[email protected]>
Co-authored-by: Tasleem222 <[email protected]>
Co-authored-by: Felix M. <[email protected]>
Co-authored-by: Hannah Paine <[email protected]>
Co-authored-by: mariekirsch <[email protected]>
Co-authored-by: Jamie Howard <[email protected]>
Co-authored-by: Michael Sadcenko <[email protected]>
Co-authored-by: devios327 <[email protected]>
Co-authored-by: Marco A. <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: updated content PRs updating existing documentation content source: CMS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant