public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
* [pbs-devel] [PATCH proxmox-backup] docs: exand PBS to Proxmox Backup (Server)
@ 2023-03-28 12:12 Fabian Grünbichler
  2023-03-28 12:19 ` [pbs-devel] applied: " Thomas Lamprecht
  2023-03-28 12:21 ` [pbs-devel] " Thomas Lamprecht
  0 siblings, 2 replies; 3+ messages in thread
From: Fabian Grünbichler @ 2023-03-28 12:12 UTC (permalink / raw)
  To: pbs-devel

where applicable.

Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
---

Notes:
    we don't yet have a PBS shorthand that gets auto-expanded, not sure whether we
    want one at some point?

 docs/gui.rst                              |  4 ++--
 docs/introduction.rst                     |  2 +-
 docs/package-repositories.rst             |  2 +-
 docs/proxmox-file-restore/description.rst |  5 +++--
 docs/prune-simulator/index.html           |  2 +-
 docs/user-management.rst                  | 18 +++++++++---------
 6 files changed, 17 insertions(+), 16 deletions(-)

diff --git a/docs/gui.rst b/docs/gui.rst
index b9dc388c..5ccfd1ae 100644
--- a/docs/gui.rst
+++ b/docs/gui.rst
@@ -31,7 +31,7 @@ Login
 .. image:: images/screenshots/pbs-gui-login-window.png
   :target: _images/pbs-gui-login-window.png
   :align: right
-  :alt: PBS login window
+  :alt: Proxmox Backup Server login window
 
 When you connect to the web interface, you will first see the login window.
 Proxmox Backup Server supports various languages and authentication back ends
@@ -47,7 +47,7 @@ GUI Overview
 .. image:: images/screenshots/pbs-gui-dashboard.png
   :target: _images/pbs-gui-dashboard.png
   :align: right
-  :alt: PBS GUI Dashboard
+  :alt: Proxmox Backup Server GUI Dashboard
 
 The Proxmox Backup Server web interface consists of 3 main sections:
 
diff --git a/docs/introduction.rst b/docs/introduction.rst
index 5d5f6297..2bc0f559 100644
--- a/docs/introduction.rst
+++ b/docs/introduction.rst
@@ -178,7 +178,7 @@ Mailing Lists
 Proxmox Backup Server is fully open-source and contributions are welcome! Here
 is the primary communication channel for developers:
 
-:Mailing list for developers: `PBS Development List`_
+:Mailing list for developers: `Proxmox Backup Sever Development List`_
 
 Bug Tracker
 ~~~~~~~~~~~
diff --git a/docs/package-repositories.rst b/docs/package-repositories.rst
index 1d2dab8c..943dc7ba 100644
--- a/docs/package-repositories.rst
+++ b/docs/package-repositories.rst
@@ -110,7 +110,7 @@ We recommend to configure this repository in ``/etc/apt/sources.list``.
   deb http://ftp.debian.org/debian bullseye main contrib
   deb http://ftp.debian.org/debian bullseye-updates main contrib
 
-  # PBS pbs-no-subscription repository provided by proxmox.com,
+  # Proxmox Backup Server pbs-no-subscription repository provided by proxmox.com,
   # NOT recommended for production use
   deb http://download.proxmox.com/debian/pbs bullseye pbs-no-subscription
 
diff --git a/docs/proxmox-file-restore/description.rst b/docs/proxmox-file-restore/description.rst
index 605dd12c..a7f3cb56 100644
--- a/docs/proxmox-file-restore/description.rst
+++ b/docs/proxmox-file-restore/description.rst
@@ -1,3 +1,4 @@
-Command line tool for restoring files and directories from PBS archives. In contrast to
-proxmox-backup-client, this supports both container/host and VM backups.
+Command line tool for restoring files and directories from Proxmox Backup
+archives. In contrast to proxmox-backup-client, this supports both
+container/host and VM backups.
 
diff --git a/docs/prune-simulator/index.html b/docs/prune-simulator/index.html
index 861d560b..0f0da395 100644
--- a/docs/prune-simulator/index.html
+++ b/docs/prune-simulator/index.html
@@ -3,7 +3,7 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
-    <title>PBS Prune Simulator</title>
+    <title>Proxmox Backup Server Prune Simulator</title>
 
     <link rel="stylesheet" type="text/css" href="extjs/theme-crisp/resources/theme-crisp-all.css">
     <style>
diff --git a/docs/user-management.rst b/docs/user-management.rst
index 5885f1c1..ec2eb057 100644
--- a/docs/user-management.rst
+++ b/docs/user-management.rst
@@ -595,21 +595,21 @@ in the following LDIF dataset, the user ``user1`` has the unique domain
 
 In in similar manner, Proxmox Backup Server uses user identifiers (``userid``)
 to uniquely identify users. Thus, it is necessary to establish a mapping
-between PBS's ``userid`` and LDAP's ``dn``. This mapping is established by
-the ``user-attr`` configuration parameter - it contains the name of the LDAP
-attribute containing a valid PBS user identifier.
+between a Proxmox Backup Server ``userid`` and an LDAP ``dn``. This mapping is
+established by the ``user-attr`` configuration parameter - it contains the name
+of the LDAP attribute containing a valid Proxmox Backup Server user identifier.
 
 For the example above, setting ``user-attr`` to ``uid`` will have the effect
 that the user ``user1@<realm-name>`` will be mapped to the LDAP entity
-``uid=user1,ou=People,dc=ldap-test,dc=com``. On user login, PBS will perform
-a `subtree search` under the configured Base Domain (``base-dn``) to query
-the user's ``dn``. Once the ``dn`` is known, an LDAP bind operation is performed
-to authenticate the user against the LDAP server.
+``uid=user1,ou=People,dc=ldap-test,dc=com``. On user login, Proxmox Backup
+Server will perform a `subtree search` under the configured Base Domain
+(``base-dn``) to query the user's ``dn``. Once the ``dn`` is known, an LDAP
+bind operation is performed to authenticate the user against the LDAP server.
 
 As not all LDAP servers allow `anonymous` search operations, it is possible to
 configure a bind domain (``bind-dn``) and a bind password (``password``).
-If set, PBS will bind to the LDAP server using these credentials before
-performing any search operations.
+If set, Proxmox Backup Server will bind to the LDAP server using these
+credentials before performing any search operations.
 
 A full list of all configuration parameters can be found at :ref:`domains.cfg`.
 
-- 
2.30.2





^ permalink raw reply	[flat|nested] 3+ messages in thread

* [pbs-devel] applied: [PATCH proxmox-backup] docs: exand PBS to Proxmox Backup (Server)
  2023-03-28 12:12 [pbs-devel] [PATCH proxmox-backup] docs: exand PBS to Proxmox Backup (Server) Fabian Grünbichler
@ 2023-03-28 12:19 ` Thomas Lamprecht
  2023-03-28 12:21 ` [pbs-devel] " Thomas Lamprecht
  1 sibling, 0 replies; 3+ messages in thread
From: Thomas Lamprecht @ 2023-03-28 12:19 UTC (permalink / raw)
  To: Proxmox Backup Server development discussion, Fabian Grünbichler

Am 28/03/2023 um 14:12 schrieb Fabian Grünbichler:
> where applicable.
> 
> Signed-off-by: Fabian Grünbichler <f.gruenbichler@proxmox.com>
> ---
> 
> Notes:
>     we don't yet have a PBS shorthand that gets auto-expanded, not sure whether we
>     want one at some point?
> 
>  docs/gui.rst                              |  4 ++--
>  docs/introduction.rst                     |  2 +-
>  docs/package-repositories.rst             |  2 +-
>  docs/proxmox-file-restore/description.rst |  5 +++--
>  docs/prune-simulator/index.html           |  2 +-
>  docs/user-management.rst                  | 18 +++++++++---------
>  6 files changed, 17 insertions(+), 16 deletions(-)
> 
>

applied, thanks!




^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [pbs-devel] [PATCH proxmox-backup] docs: exand PBS to Proxmox Backup (Server)
  2023-03-28 12:12 [pbs-devel] [PATCH proxmox-backup] docs: exand PBS to Proxmox Backup (Server) Fabian Grünbichler
  2023-03-28 12:19 ` [pbs-devel] applied: " Thomas Lamprecht
@ 2023-03-28 12:21 ` Thomas Lamprecht
  1 sibling, 0 replies; 3+ messages in thread
From: Thomas Lamprecht @ 2023-03-28 12:21 UTC (permalink / raw)
  To: Proxmox Backup Server development discussion, Fabian Grünbichler

Am 28/03/2023 um 14:12 schrieb Fabian Grünbichler:
> we don't yet have a PBS shorthand that gets auto-expanded, not sure whether we want one at some point?

IMO not really worth it, until I've remembered the correct syntax from our
jungle of different docs, and typed that, I'd have typed or copy+pasted the
whole thing probably faster.




^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2023-03-28 12:21 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-03-28 12:12 [pbs-devel] [PATCH proxmox-backup] docs: exand PBS to Proxmox Backup (Server) Fabian Grünbichler
2023-03-28 12:19 ` [pbs-devel] applied: " Thomas Lamprecht
2023-03-28 12:21 ` [pbs-devel] " Thomas Lamprecht

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