feat: docs update

swiftwave-org · Feb 19, 2024 · f188cdd · f188cdd
1 parent b0a8c5c
commit f188cdd
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 4 deletions.
diff --git a/docs/dashboard/persistent-volumes.md b/docs/dashboard/persistent-volumes.md
@@ -8,7 +8,45 @@ In **Persistent Volumes** section, you can see all the persistent volumes create
 
 ![Persistent Volume List](/assets/persistent-volumes.png)
 
-**You can **
-- **Create** a new persistent volume by clicking on `Add New` button.
-- **Delete** a persistent volume by clicking on `Delete` button.
-  > Note : You can only delete a persistent volume if it is not being used by any application.
+### Create a Persistent Volume
+1. Click on `Add New` button.
+2. Put a name for the persistent volume.
+   > Note : The name should be unique and can't contain spaces.
+3. Submit.
+
+### Delete a Persistent Volume
+Just click on `Delete` button to delete a persistent volume.
+
+### Analyze Size of Persistent Volume
+You can click on `Fetch Size` button to fetch size of the persistent volume.
+
+### Backup Volume
+1. You can backup and take snapshot of the persistent volume by clicking on `Create Backup` button.
+2. You can choose type of backup.
+    - **Local** : The backup will be stored locally in the server itself.
+    - **S3** : The backup will be stored in S3 bucket. You need to configure S3 beforehand to avail this feature.
+      > You can open  swiftwave config by [`swiftwave config -e vim`](/docs/cli/config) command
+3. Submit to create backup.
+4. You can open the backup history by `Show Backups` button to see the status of the backup.
+
+### Backup History
+You can click on `Show Backups` button to see the backup history of the volume.
+
+![Backup History](/assets/backup-history.png)
+
+- You can check status of old backups.
+- You can also download the backup file by clicking on `Download Backup` button.
+
+
+### Restore Volume
+1. You can upload a backup file to restore the volume by clicking on `Restore Now` button.
+2. Upload the backup file.
+3. Submit to restore the volume.
+4. You can open the restore history by `Show Restores` button to see the status of the restore.
+
+### Restore History
+You can click on `Restore History` button to see the restore history of the volume.
+
+![Restore History](/assets/restore-history.png)
+
+- You can check status of all restores.
diff --git a/docs/index.md b/docs/index.md
@@ -30,6 +30,7 @@ Experience the ease of deployment and management with SwiftWave! 🌊
 - **Flexible Restart**: Restart your application at your convenience 🔄
 - **Scaling Made Easy**: Scale your application effortlessly with just one click 🔍
 - **Log Insight**: Easily check logs for your application 📋
+- **Backup & Restore**: Backup and restore your application with just one click 🔄
 
 ### 🛣️ Traffic Control
 - **Custom Domains**: Add custom domains and auto-issue SSL certificates with just one click 🔒

diff --git a/static/assets/backup-history.png b/static/assets/backup-history.png
diff --git a/static/assets/persistent-volumes.png b/static/assets/persistent-volumes.png
diff --git a/static/assets/restore-history.png b/static/assets/restore-history.png