public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Stoiko Ivanov <s.ivanov@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup 0/6] docs: cleanup and add certificate docs
Date: Mon, 16 May 2022 16:27:27 +0000	[thread overview]
Message-ID: <20220516162733.62060-1-s.ivanov@proxmox.com> (raw)

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





             reply	other threads:[~2022-05-16 16:27 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-16 16:27 Stoiko Ivanov [this message]
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 1/6] docs: silence duplicate label warnings Stoiko Ivanov
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 2/6] docs: cleanup and readd command-line-tools Stoiko Ivanov
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 3/6] docs: use case-matching keys for glossary Stoiko Ivanov
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 4/6] docs: add certificate-management.rst Stoiko Ivanov
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 5/6] docs: certificates Stoiko Ivanov
2022-05-16 16:27 ` [pbs-devel] [PATCH proxmox-backup 6/6] docs: certs: add screenshots Stoiko Ivanov
2022-05-16 17:28 ` [pbs-devel] applied: [PATCH proxmox-backup 0/6] docs: cleanup and add certificate docs Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220516162733.62060-1-s.ivanov@proxmox.com \
    --to=s.ivanov@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal