[pbs-devel] [PATCH proxmox-backup 0/6] docs: cleanup and add certificate docs

Stoiko Ivanov s.ivanov at proxmox.com
Mon May 16 18:27:27 CEST 2022


while trying to add the certificate documentation I noticed a few
(rather harmless) warnings while running make html

patches 1-3 address those and are independent of the certificate
documentation (3-6).

For the certificate docs I took the approach of (semi) automatically
converting the ssl-docs from pmg-docs to rst (asciidoc->docbook (via
asciidoc), docbook->rst (via pandoc)) - the exact commands are
in the commit message of 4/6.

The mid-term idea here would be to have one single source for the common
docs (system-booting, local-zfs and parts of the certificate
documentation come to mind for now) - since keeping them in multiple
places, but with similar/identical content just means that improvments
don't make it to all copies (or only with quite a bit of manual
vimdiffing by the code-reviewers)



Stoiko Ivanov (6):
  docs: silence duplicate label warnings.
  docs: cleanup and readd command-line-tools
  docs: use case-matching keys for glossary
  docs: add certificate-management.rst
  docs: certificates
  docs: certs: add screenshots

 docs/certificate-management.rst               | 331 ++++++++++++++++++
 docs/command-line-tools.rst                   |  27 +-
 docs/command-syntax.rst                       |  10 +
 docs/conf.py                                  |   6 +-
 .../screenshots/pbs-gui-acme-add-domain.png   | Bin 0 -> 11638 bytes
 .../pbs-gui-acme-create-account.png           | Bin 0 -> 19818 bytes
 .../pbs-gui-acme-create-challenge-plugin.png  | Bin 0 -> 24795 bytes
 .../pbs-gui-certs-upload-custom.png           | Bin 0 -> 34209 bytes
 docs/introduction.rst                         |  21 +-
 docs/sysadmin.rst                             |   4 +
 docs/terminology.rst                          |  11 +-
 11 files changed, 387 insertions(+), 23 deletions(-)
 create mode 100644 docs/certificate-management.rst
 create mode 100644 docs/images/screenshots/pbs-gui-acme-add-domain.png
 create mode 100644 docs/images/screenshots/pbs-gui-acme-create-account.png
 create mode 100644 docs/images/screenshots/pbs-gui-acme-create-challenge-plugin.png
 create mode 100644 docs/images/screenshots/pbs-gui-certs-upload-custom.png

-- 
2.30.2






More information about the pbs-devel mailing list