Repository navigation
docs(admin): document recovery of orphaned identification documents - #176
Open
maia-andre wants to merge 1 commit into
Open
maia-andre wants to merge 1 commit into
maia-andre wants to merge 1 commit into
Conversation
Explain libresign:id-docs:recover: what the statuses mean, backups, the dry-run, what --execute does, how to verify, why the originals are kept, how to retry after a failure and the limitations. Signed-off-by: André Maia <andrefnkmm@gmail.com>
12 of 13 tasks
This branch has not been deployed
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
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.
Resolves / related issue
Part of LibreSign/libresign#9168. Documents the command added in LibreSign/libresign#9535.
Summary and validation
Adds a section to the admin manual (the
maintenance.rstpage, empty until now) onocc libresign:id-docs:recover. It covers what each status means, what to back up first, the dry-run, what--executedoes, how to verify the result, why the originals are kept, how to retry after a failure or an interruption, and the limitations.Affected versions: the next major release (the command is main-only for now). The text was checked against the command's behavior on an isolated instance. I didn't build the docs locally; I only checked heading underlines. I'll review the CI preview.
Navigable preview
To be checked in the CI preview of this PR.
Checklist
The content of this PR was partially generated using AI and reviewed by me.