[docs] Fix instructions about restoring snapshots, fixes #4778 #4779
Conversation
Correct the instructions how to restore a given snapshot. Closes ddev#4778
rfay
changed the title
There was a problem hiding this comment.
Thanks for this contribution, sorry it got stalled. @mattstein I assume it's OK with you?
docs/content/users/usage/cli.md
Outdated
| Stopping db container for snapshot restore of 'd9_20220107124831-mariadb_10.3.gz'... | ||
| Restored database snapshot d9_20220107124831-mariadb_10.3.gz | ||
| ``` | ||
|
|
||
| Snapshots are stored as gzipped files in the project’s `.ddev/db_snapshots` directory, and the file created for a snapshot can be renamed as necessary. For example, if you rename the above `d9_20220107124831-mariadb_10.3.gz` file to `working-before-migration-mariadb_10.3.gz`, then you can use `ddev snapshot restore working-before-migration-mariadb_10.3.gz`. (The description of the database type and version—`mariadb_10.3`, for example—must remain intact.) | ||
| Snapshots are stored as gzipped files in the project’s `.ddev/db_snapshots` directory, and the file created for a snapshot can be renamed as necessary. For example, if you rename the above `d9_20220107124831-mariadb_10.3.gz` file to `working-before-migration-mariadb_10.3.gz`, then you can use `ddev snapshot restore working-before-migration`. (The description of the database type and version — `mariadb_10.3`, for example — must remain intact.) |
There was a problem hiding this comment.
Looks like you specifically added spaces around the em dash. Apparently Chicago and AP Style are split on this, but in the docs we’ve consistently gone with the spaceless variant aside from this change. Would you mind changing it back or is there a compelling reason we should adopt this style?
There was a problem hiding this comment.
@rfay My account got flagged (39 days! And they even didn't tell me why it was flagged...), therefore all my contributions were hidden.
@mattstein Oh, I was not aware that there are rules for this (english is not my mother tongue). I just added them because it looked falsy. But of course can I change it back. I will push an update today.
There was a problem hiding this comment.
That explains why I didn't see it! Thanks for letting me know.
There was a problem hiding this comment.
Thank you @rintisch!
Remove prior added whitespaces around em dash to achieve consistent writing style. stick
The Issue
#4778
How This PR Solves The Issue
Corrects the incorrect instructions
Manual Testing Instructions
Automated Testing Overview
No tests needed, its only about docs.
Related Issue Link(s)
Release/Deployment Notes
Not related to deployment.