docs: ssh debug integration docs

[yanksyoon]

Applicable spec: N/A

Overview

This is a follow up PR to #176, which adds documentation around ssh-debug integration's usage.

Rationale

To guide users on using ssh-debug integration.

Juju Events Changes

None.

Module Changes

None.

Library Changes

None.

Checklist

• The charm style guide was applied
• The contributing guide was applied
• The changes are compliant with ISD054 - Managing Charm Complexity
• The documentation is generated using src-docs
• The documentation for charmhub is updated.
• The PR is tagged with appropriate label (urgent, trivial, complex)

[github-actions]

Test coverage for 5c68588

Name                         Stmts   Miss Branch BrPart  Cover   Missing
------------------------------------------------------------------------
src/charm.py                   459    111    117     26    73%   86-88, 112-113, 117-119, 157-159, 169->181, 179, 214-233, 242-243, 257-259, 260->272, 263->272, 296-300, 331, 411-416, 439, 456-457, 466-489, 509-514, 520-523, 530, 533-534, 550, 554-559, 604->607, 620-621, 623-624, 658-665, 689-690, 702-704, 719-720, 748-749, 751-752, 754-755, 829->831, 892-893, 909, 927-929, 933-935, 939
src/charm_state.py             136     18     18      3    85%   131-138, 220-221, 260-262, 273-274, 280-285, 296-298
src/errors.py                   39      0      0      0   100%
src/event_timer.py              45      9      6      1    73%   80, 100-103, 123-126
src/firewall.py                 43     25     10      0    38%   38-42, 64-67, 75-149
src/github_client.py            68      6     32      3    87%   124, 146, 158-165, 183->216
src/github_metrics.py           14      0      0      0   100%
src/github_type.py              50      0      0      0   100%
src/lxd_type.py                 37      0      2      0   100%
src/metrics.py                  73      2     10      1    96%   61->64, 170-171
src/metrics_type.py              6      0      0      0   100%
src/runner.py                  320     70     96     24    73%   44->46, 125, 252-253, 294-303, 327-332, 337, 357, 361-371, 420->423, 426-428, 435, 449, 459, 463, 465, 480, 506-511, 527-540, 551-590, 595, 633, 680-682, 686, 704, 739, 765, 770-782, 796, 801->803, 806-808
src/runner_logs.py              35      2      6      1    93%   62->61, 66-67
src/runner_manager.py          274     47     90      8    82%   122, 167-169, 182-183, 195-197, 203-208, 212-213, 223-224, 243, 286-287, 331-333, 398, 418-422, 447, 499-502, 538, 645-658, 668, 673-684
src/runner_manager_type.py      33      0      6      0   100%
src/runner_metrics.py          123      8     20      2    93%   147-148, 160, 191-192, 307-311
src/runner_type.py              47      0     10      0   100%
src/shared_fs.py               116     16     20      0    88%   108-109, 133-134, 217-218, 241-242, 254-255, 260-261, 267-268, 292-293
src/utilities.py                68      5     20      7    86%   74->76, 78->84, 91, 121, 135, 173, 226
------------------------------------------------------------------------
TOTAL                         1986    319    463     76    81%

Static code analysis report

Run started:2024-01-22 06:48:30.779893

Test results:
  No issues identified.

Code scanned:
  Total lines of code: 4332
  Total lines skipped (#nosec): 0
  Total potential issues skipped due to specifically being disabled (e.g., #nosec BXXX): 12

Run metrics:
  Total issues (by severity):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
  Total issues (by confidence):
  	Undefined: 0
  	Low: 0
  	Medium: 0
  	High: 0
Files skipped (0):