Skip to content

Docs: document --backupdb argument for inv docker.manage#12617

Merged
humitos merged 2 commits into
readthedocs:mainfrom
nikblanchet:docs/document-backupdb-argument
Dec 1, 2025
Merged

Docs: document --backupdb argument for inv docker.manage#12617
humitos merged 2 commits into
readthedocs:mainfrom
nikblanchet:docs/document-backupdb-argument

Conversation

@nikblanchet

@nikblanchet nikblanchet commented Nov 28, 2025

Copy link
Copy Markdown
Contributor

Closes #7761

Summary

  • Documents the --backupdb argument for inv docker.manage
  • Describes the backup filename pattern: dump_<DD-MM-YYYY>_<HH_MM_SS>__<git-hash>.sql
  • Adds restore instructions with step-by-step commands

Note: #8708 proposes a restoredb invoke task to automate restoration. The manual workflow documented here can coexist with that automation if it lands.

Test plan

  • Built docs locally with make PROJECT=dev html - renders correctly
  • Tested inv docker.manage --backupdb showmigrations - backup file created with documented pattern

Generated with Claude Code
Steered and reviewed by @nikblanchet (mostly human)

nikblanchet and others added 2 commits November 24, 2025 22:34
Generated with [Claude Code](https://claude.com/claude-code)
Steered and reviewed by @nikblanchet (mostly human)

Co-Authored-By: Claude <noreply@anthropic.com>
The backup filename includes timestamp and git hash, not just "dump.sql".
Updated restore example to show the actual filename pattern.

Generated with [Claude Code](https://claude.com/claude-code)
Steered and reviewed by @nikblanchet (mostly human)

Co-Authored-By: Claude <noreply@anthropic.com>
@nikblanchet nikblanchet requested a review from a team as a code owner November 28, 2025 16:03
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 dev | 🛠️ Build #30494795 | 📁 Comparing 68502ee against latest (391a5a0)


🔍 Preview build

Show files changed (1 files in total): 📝 1 modified | ➕ 0 added | ➖ 0 deleted
File Status
install.html 📝 modified

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 docs | 🛠️ Build #30494796 | 📁 Comparing 68502ee against latest (391a5a0)


🔍 Preview build

Show files changed (24 files in total): 📝 21 modified | ➕ 0 added | ➖ 3 deleted
File Status
glossary.html 📝 modified
link-previews.html 📝 modified
visual-diff.html 📝 modified
config-file/v2.html 📝 modified
guides/cross-referencing-with-sphinx.html 📝 modified
guides/deprecating-content.html 📝 modified
guides/intersphinx.html 📝 modified
guides/jupyter.html 📝 modified
guides/technical-docs-seo-guide.html 📝 modified
intro/antora.html 📝 modified
intro/doctools.html 📝 modified
intro/docusaurus.html 📝 modified
intro/markdoc.html 📝 modified
intro/mdbook.html 📝 modified
intro/mkdocs.html 📝 modified
intro/mystmd.html ➖ deleted
intro/sphinx.html 📝 modified
intro/vitepress.html 📝 modified
intro/zensical.html ➖ deleted
reference/main-content-detection.html ➖ deleted
server-side-search/index.html 📝 modified
tutorial/index.html 📝 modified
tutorials/index.html 📝 modified
guides/setup/monorepo.html 📝 modified

@humitos humitos left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

@humitos humitos merged commit f6d87eb into readthedocs:main Dec 1, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Development: document --backupdb argument and load db data from dump

2 participants