Skip to content

[docs] Adding ways of import data guide - #4032

Merged
fellyph merged 10 commits into
trunkfrom
adding-import-data-guide
Jul 24, 2026
Merged

[docs] Adding ways of import data guide#4032
fellyph merged 10 commits into
trunkfrom
adding-import-data-guide

Conversation

@fellyph

@fellyph fellyph commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

This pull request adds a comprehensive new guide comparing the main methods for importing content into WordPress Playground using Blueprints, and updates related documentation to clarify the available strategies and their trade-offs. The changes provide practical examples, pros and cons, and benchmarking data for XML (WXR), PHP, and ZIP-based imports, while also improving the clarity and completeness of existing guides on content provisioning.

New Guide: Importing Content with Blueprints

  • Added a new guide, import-content-with-blueprints.md, that compares the three primary methods for importing content into WordPress Playground: WXR (XML export), runPHP (generated content), and ZIP snapshots. The guide includes detailed examples, pros and cons, and a reproducible benchmark for each method.
  • Linked the new guide from the guides index with a summary of its contents and focus.

Enhancements to Existing Content Provisioning Guide

  • Updated providing-content-for-your-demo.md to reference the new comparison guide and clarify the available Blueprint steps for importing content. Expanded and improved examples for importWxr, including attachment handling, author mapping, and bundling strategies.
  • Improved documentation for importWordPressFiles, explaining ZIP creation, restoration, and security considerations, along with updated example usage.
  • Enhanced sections on importThemeStarterContent and installTheme to clarify how starter content can be published, with improved code samples and explanations.
  • Refined the wp-cli section to clarify usage, show how to combine with writeFile, and provide clearer examples.
@fellyph
fellyph requested review from a team, Copilot and mho22 July 13, 2026 15:22
@github-actions github-actions Bot added the [Type] Documentation Improvements or additions to documentation label Jul 13, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a new “Import content with Blueprints” guide (including benchmarking and trade-offs) and updates existing content-provisioning docs and guide indexes to reference and align with the new guidance.

Changes:

  • Added a new import-content-with-blueprints guide (EN + translations).
  • Updated “Providing content for your demo” guides (EN + translations) with clearer examples and cross-links.
  • Linked the new guide from the guides index and sidebar navigation.

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
packages/docs/site/sidebars.js Adds the new guide to the main guides sidebar navigation.
packages/docs/site/docs/main/guides/index.md Links to the new import comparison guide from the main guides index.
packages/docs/site/docs/main/guides/import-content-with-blueprints.md New EN guide describing/benchmarking WXR vs runPHP vs ZIP snapshot imports.
packages/docs/site/docs/main/guides/providing-content-for-your-demo.md Expands EN content provisioning guide with improved examples and references to the new comparison guide.
packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/main/guides/index.md Links to the new guide in the pt-BR guides index.
packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/main/guides/import-content-with-blueprints.md New pt-BR guide (translation) for import comparison.
packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/main/guides/providing-content-for-your-demo.md Updates pt-BR content provisioning guide with expanded examples and references.
packages/docs/site/i18n/it/docusaurus-plugin-content-docs/current/main/guides/import-content-with-blueprints.md New it guide (translation) for import comparison.
packages/docs/site/i18n/it/docusaurus-plugin-content-docs/current/main/guides/providing-content-for-your-demo.md Adds/updates it content provisioning guide with expanded examples and references.
packages/docs/site/i18n/fr/docusaurus-plugin-content-docs/current/main/guides/index.md Links to the new guide in the fr guides index.
packages/docs/site/i18n/fr/docusaurus-plugin-content-docs/current/main/guides/import-content-with-blueprints.md New fr guide (translation) for import comparison.
packages/docs/site/i18n/es/docusaurus-plugin-content-docs/current/main/guides/import-content-with-blueprints.md New es guide (translation) for import comparison.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/docs/site/docs/main/guides/providing-content-for-your-demo.md Outdated
Comment thread packages/docs/site/docs/main/guides/providing-content-for-your-demo.md Outdated
Comment thread packages/docs/site/docs/main/guides/import-content-with-blueprints.md Outdated
Comment thread packages/docs/site/docs/main/guides/import-content-with-blueprints.md Outdated
Comment thread packages/docs/site/docs/main/guides/import-content-with-blueprints.md Outdated
@fellyph
fellyph merged commit 7a3e242 into trunk Jul 24, 2026
52 of 53 checks passed
@fellyph
fellyph deleted the adding-import-data-guide branch July 24, 2026 10:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Documentation Improvements or additions to documentation

3 participants