[MGNLUI-6776] DOC: Better define scope of Backup module Created: 07/May/21  Updated: 14/Jul/21  Resolved: 14/Jul/21

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: 6.2
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Jürgen Brömmer Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: services
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
relation
is related to MGNLBACKUP-139 Unable to commit volatile index Open
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:
Sprint: UI FW 32
Story Points: 2

 Description   

Hi, 

for production environments we recommend to use database tools (plus filesystem copy) to have a consistent and transaction-safe backup. 

We should mention that somewhere because now customers expect that our backup module is the best solution for that (while it is slow and is known to cause issues).

So I would expect something like a box that tells to use the module only for specific cases (cross-platform dump, small databases, awarinner should know more). Maybe also an additional best-practice advice.

wdyt?



 Comments   
Comment by Roman Kovařík [ 07/Jul/21 ]

https://docs.magnolia-cms.com/product-docs/6.2/Modules/List-of-modules/Backup-module.html

Comment by Ashraf Khamis [ 14/Jul/21 ]

Added a note at the top of https://docs.magnolia-cms.com/product-docs/6.2/Modules/List-of-modules/Backup-module.html about the limitations of the Backup module. Fixed all broken links and formatting issues at both https://docs.magnolia-cms.com/product-docs/6.2/Apps/List-of-apps/Backup-app.html and https://docs.magnolia-cms.com/product-docs/6.2/Modules/List-of-modules/Backup-module.html and reviewed the language. Replaced old screenshots and links to Magnolia 5 UI and updated several app pages for consistency.

Reviewed by Roman & Andrew.

Generated at Mon Feb 12 09:39:53 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.