Skip to content

docs(admin): document recovery of orphaned identification documents - #176

Open
maia-andre wants to merge 1 commit into
LibreSign:mainfrom
maia-andre:docs/9168-recover-id-docs
Open

maia-andre wants to merge 1 commit into
LibreSign:mainfrom
maia-andre:docs/9168-recover-id-docs

Conversation

@maia-andre

Copy link
Copy Markdown
Contributor

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.rst page, empty until now) on occ libresign:id-docs:recover. It covers what each status means, what to back up first, the dry-run, what --execute does, 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

  • I checked the affected release-specific source and OpenAPI contracts.
  • I built the relevant docs or verified the CI result.
  • I reviewed the navigable preview: navigation, links, code blocks and layout.
  • I did not include secrets, private documents or real personal data.
  • I kept the change focused on one documentation concern.
  • My commits include DCO sign-off.

The content of this PR was partially generated using AI and reviewed by me.

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>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant