Skip to content

📚 Documentation|Feature: Enhance Backups Section with Tutorials and Pre-Migration Prompt #643

@ItzNotABug

Description

@ItzNotABug

💭 Description

The current backups section in the documentation lists steps that start with "Create a script".
This might be challenging as well as time consuming for users who are new or unfamiliar with appwrite or Server Side APIs.

Suggestions:

  • Link to Tutorials/Scripts
    It would be helpful to have tutorials or scripts linked directly in the backups section.
    These could be created by community members (validated by maintainers) or the maintainers themselves. Having a dedicated tutorial linked on the same page will provide clear guidance.

  • Pre-Migration Prompt
    Before initiating a migration, it would be helpful to display a prompt or message reminding the user about the backups.
    An example message could be:

You are migrating from 1.3.8 to 1.4.0 which is a major release. Please ensure you've backed up your Appwrite instance.\
If you haven't, please follow this guide: https://appwrite.io/docs/production#backups
  • Backup Confirmation
    Before proceeding with the migration, consider adding a prompt to confirm if the user has backed up their Appwrite instance. This acts as a safety measure, example:
Have you backed up your Appwrite instance? [Y/n]:

These enhancements will ensure safer migrations, reducing the potential for configuration errors or data loss on appwrite's major releases.

Note: Suggested first on Discord.

👀 Have you spent some time to check if this issue has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions