docs: document the backup/restore ZIP archive format#604
docs: document the backup/restore ZIP archive format#604irfanuddinahmad wants to merge 2 commits into
Conversation
Adds a reference page describing the TOML-based ZIP format produced by `create_zip_file` / `lp_dump` and consumed by `load_learning_package` / `lp_load`. Covers the full archive layout, every TOML file schema with field-level descriptions and annotated examples drawn from the test fixtures, the XBlock XML placement convention, and quick-start usage snippets for both the management commands and the Python API. Closes openedx#492 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Thanks for the pull request, @irfanuddinahmad! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
There was a problem hiding this comment.
Pull request overview
This PR adds official documentation for the ZIP-based learning-package backup/restore format used by the backup_restore applet, and links it into the openedx_content docs section so operators and developers can understand and inspect archives produced/consumed by lp_dump / lp_load.
Changes:
- Add a new reference page documenting the archive layout and TOML/XML schemas used in backup ZIPs.
- Include export/restore quick-start examples for both management commands and the Python API.
- Link the new page from the
docs/openedx_contentindex.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| docs/openedx_content/index.rst | Adds the new backup/restore format page to the openedx_content docs toctree. |
| docs/openedx_content/backup_restore.rst | New documentation page describing the backup ZIP layout and file formats. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``[learning_package]`` — library data (restored to the database): | ||
|
|
There was a problem hiding this comment.
Fixed. Updated the section heading to: "library data (restored to the database, with caveats: key may be overridden by the caller and updated is not applied during restore)".
- Overview: clarify only draft+published versions exported, not full history - origin_server: free-form string, not validated hostname - [learning_package] heading: note key may be overridden, updated not restored - updated field: mark as reference-only, not applied during restore - [entity.published]: always present (empty table with comment when unpublished) - [[version]]: at most 2 entries — draft first, then published if different - Example: fix version order to draft (v5) first, then published (v4) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Summary
docs/openedx_content/backup_restore.rst— a full reference page for the TOML-based ZIP format produced bylp_dump/create_zip_fileand consumed bylp_load/load_learning_package.docs/openedx_content/index.rst.Closes #492
Test plan
cd docs && make html(ormake dirhtml) — confirms RST renders without Sphinx warningstests/openedx_content/applets/backup_restore/fixtures/library_backup/lp_dumpon a real library and compare the output ZIP layout to the documented structure🤖 Generated with Claude Code