docs: extend notes on the recommended state of services during snapshot operations#396
Merged
Merged
Conversation
…ot operations Extend notes on the recommended state of services and applications when saving or restoring snapshots. Signed-off-by: Maciek Borzecki <maciej.borzecki@canonical.com>
Mohit-Chachada
left a comment
Mohit-Chachada
left a comment
Contributor
There was a problem hiding this comment.
some minor things to consider
| 30 vlc 529ms 3.0.6 770 882kB - | ||
| ``` | ||
|
|
||
| > Before using this command, in order to ensure consistency of saved data, it is recommended to stop all applications and services of the snap (`snap stop <snap-name>`). Start them again once the snapshot has been saved. |
Contributor
There was a problem hiding this comment.
Suggested change
| > Before using this command, in order to ensure consistency of saved data, it is recommended to stop all applications and services of the snap (`snap stop <snap-name>`). Start them again once the snapshot has been saved. | |
| > Before using this command, in order to ensure consistency of saved data, make sure to stop all applications and services of the snaps included in the snapshot (`snap stop <snap-name>`). Start them again once the snapshot has been successfully saved. |
just to keep similar wording for both of them
Contributor
There was a problem hiding this comment.
oh also, snap stop <snap-name> doesn't really stop snap apps, should we recommend the reader on how to do that too?
Edit: ok we decided to leave it as is for now as there is not a direct command to kill snap apps but we think it makes sense to add one (something for future)
Contributor
Author
There was a problem hiding this comment.
dropped 'successfully', as we do not need the snapshot to be successful in order to be able to restart the apps and services
| 30 vlc 529ms 3.0.6 770 882kB - | ||
| ``` | ||
|
|
||
| > Before using this command, in order to ensure consistency of saved data, it is recommended to stop all applications and services of the snap (`snap stop <snap-name>`). Start them again once the snapshot has been saved. |
Contributor
There was a problem hiding this comment.
i am inclined towards highlighting it even more using {caution} tag
Suggested change
| > Before using this command, in order to ensure consistency of saved data, it is recommended to stop all applications and services of the snap (`snap stop <snap-name>`). Start them again once the snapshot has been saved. | |
| ```{caution} | |
| Before using this command... | |
| \``` |
|
|
||
| Before using this command, make sure you have the snap application installed, and that its services, if any, are stopped (`snap stop <snap-name>`). | ||
| Start them again once the snapshot has been successfully restored. | ||
| > Before using this command, make sure you have the snap installed, and that its applications and services, if any, are stopped (`snap stop <snap-name>`). Start them again once the snapshot has been successfully restored. |
Contributor
There was a problem hiding this comment.
same {caution} here
… snapshot operations
… snapshot operations
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Extend notes on the recommended state of services and applications when saving or restoring snapshots.