Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
2 tasks done
ItzNotABug opened this issue Aug 31, 2023 · 4 comments
Open
2 tasks done
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ItzNotABug
Copy link
Member

💭 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?

@joeyouss joeyouss added the enhancement New feature or request label Aug 31, 2023
@gewenyu99
Copy link
Contributor

gewenyu99 commented Aug 31, 2023

👀 I like this suggestion!

@joeyouss
Copy link

@ItzNotABug if you would like to contribute to it, then great! Else, I've opened this issue for contributions.

@rishidyno
Copy link

@ItzNotABug I would like to work on this issue.

@stnguyen90
Copy link
Contributor

@eldadfux eldadfux transferred this issue from appwrite/appwrite Feb 19, 2024
@eldadfux eldadfux added the documentation Improvements or additions to documentation label Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

6 participants