One of the core features of PMG is the rule-system, which is documented in
'pmg-mail-filter.adoc' under the (correct) heading of 'Mail Filter'
In quite a few other places [0,1] where the features of PMG are highlighted we
refer to the (Object Oriented) Rule System.
When skimming through the documentation and quickly glancing at links the
connection 'Rule System' <-> 'Mail Filter' is not directly apparent and could
cause confusion.
This is addressed by adding 'Rule-Based' as prefix to the chapter title.
[0] https://www.proxmox.com/en/proxmox-mail-gateway/features
[1] https://pmg.proxmox.com/pmg-docs/pmg-admin-guide.html#_features
Reported-by: Daniela Häsler <daniela@proxmox.com>
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
the apache/conf-available snippet for pmg-docs-apache should be named like the
package according to lintian (non-standard-apache2-configuration-name).
move the configfile via dpkg-maintscript-helper(1) (see the manpage for
the explaination of the prior version of 6.0-3~) and dh_installdeb(1).
Tested by upgrading pmg-docs-apache to a version with this commit, while having
modifications in '/etc/apache2/conf-available/pmg-docs.conf'
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
pmg.proxmox.com does not host only the documentation the default redirect
to '/pmg-docs' should be removed
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
The loading of an external hosted ExtJS is from a time where we did
not have a extra ExtJS package as it still was in the pve-manager
one, which was not desired to be installed on a non-pmg machine.
Add a dependency on libjs-extjs and a link from api-viewer/extjs to
the installation directory of the ExtJS package, this allows to reuse
ExtJS on PMG node hosted docs and on the hosted docs from proxmox.com
at the same time.
Adapted from the Proxmox VE version[0] of this change.
[0]: https://git.proxmox.com/?p=pve-docs.git;a=commitdiff;h=e56030c4d7c3bd0de1ebc109d528fb6b7bef05a3
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
containing a short apache-config snippet for delivering the pmg-docs via apache.
Mostly added for consistency between pve-docs (containing pve-docs-mediawiki)
and pmg-docs (containing pmg-docs-apache, because it does not have a wiki)
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
Requested by Martin as the support@ address is now quite wired to the
enterprise support ticket system, and office is for more general
requests.
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This ensures that code blocks with [source,<lang>] blocks get
rendered correctly in HTML output.
While we only have one such block, and we could remove the
source highlighting tag completely here we use this in pve-docs and
also have the dependency there correctly, so it makes sense to make
share this here, else a copied text from pve-docs may be incompatible
here
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
The recently added custom check API (see #1988) needs a short documentation,
explaining the correct workings of a custom check executable.
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
- reword text for physical and VM usage and requirements
- correct network speed unit
- extend and reword storage recommendation
Signed-off-by: Alwin Antreich <a.antreich@proxmox.com>
in pmg-copyright.adoc and pmg-admin-guide-docinfo.xml
ported from pve-docs:742e92ef45cb1a8b6b98946959f6d36abc5ac9e9
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
to improve reproducibility of pve-docs, pve-doc-generator and
pve-doc-mediawiki builds, as well as man pages generated by
pve-doc-generator when called via dpkg-buildpackage.
timestamps embedded in the documentation now always reflect the last changelog
entry of the package to which the documentation belongs (pve-docs for html,
epub and pdf, individual packages for man pages).
ported from pve-docs:b965ad63ad80b5967f5bc1f0327eb548b6049045
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
a2x only supports destination folders for HTML based variants, but fortunately
that is enough in our case without needing extra workarounds.
ported from pve-docs:959bc81c13cd84c3227a466afc981af37092f70e
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
gathered by building in a minimal Debian Stretch chroot with just the
listed build-dependencies installed.
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
build packages in one go by moving individual .deb targets into install
targets called by dpkg-buildpackage.
ported from pve-docs:fa764571f6a0c5bfc62ee1cda6bffcfae40e9ec9
and pve-docs:60955877b11cde0865a258ece040bd124fb07bdc
Additionally I added the fixups from Thomas in
pve-docs:2d11c86883c4b1150afcc97eedfbf1b2a07de105
pve-docs:fd880d44c7d3876add7acd659641668bfa09c71b
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
The phrasing regarding copying the templates from '/var/lib/pmg/templates'
to '/etc/pmg/templates' caused some confusion [0] and some users thought they
need to copy all templates to '/etc/pmg/templates', even if they only modified
one template. Rephrasing the sentence to speak of a singular template, should
explain the workings better.
Additionally a singular/plural typo was fixed
[0] https://bugzilla.proxmox.com/show_bug.cgi?id=2098 and a few forum-threads
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
