-
Notifications
You must be signed in to change notification settings - Fork 19
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
Add a README.md file to the backup directory #70
Add a README.md file to the backup directory #70
Conversation
src/locales/en_US.json
Outdated
@@ -86,6 +86,7 @@ | |||
"description": "Execute command when backup is finished" | |||
} | |||
}, | |||
"backupReadme": "# Joplin Backup\n\nThe backups in this folder were created with the Simple Backup plugin for Joplin. The most recent backup was created on %s.\n\nSee the [Simple Backup documentation](https://joplinapp.org/plugins/plugin/io.github.jackgruber.backup/#restore) for information about how to restore from this backup.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alternatively, to link to GitHub:
"backupReadme": "# Joplin Backup\n\nThe backups in this folder were created with the Simple Backup plugin for Joplin. The most recent backup was created on %s.\n\nSee the [Simple Backup documentation](https://joplinapp.org/plugins/plugin/io.github.jackgruber.backup/#restore) for information about how to restore from this backup.", | |
"backupReadme": "# Joplin Backup\n\nThe backups in this folder were created with the Simple Backup plugin for Joplin. The most recent backup was created on %s.\n\nSee the [Simple Backup documentation](https://github.com/JackGruber/joplin-plugin-backup?tab=readme-ov-file#restore) for information about how to restore from this backup.", |
We should then also write a test for the revisions and the README.md location |
src/Backup.ts
Outdated
@@ -477,6 +477,7 @@ class Backup { | |||
await this.backupNotebooks(); | |||
|
|||
const backupDst = await this.makeBackupSet(); | |||
await this.writeReadme(backupDst); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should use this.backupBasePath
otherwise the README.md is in subfolders if there are several revisions.
Thanks, I have added the German translation and removed the timestamp from the README, as this information is not meaningful if several profiles are backuped. |
Summary
Adds a README.md file to the root backup directory that links to Simple Backup's README.
Example directory structure:
Example README content:
Notes
package.json