[pve-devel] [PATCH v2 docs 2/2] add and use wiki and forum macros
Fabian Grünbichler
f.gruenbichler at proxmox.com
Tue Oct 4 14:10:24 CEST 2016
---
changes to v1:
- rebased
- use macro for two more wiki links
attributes.txt | 4 ++++
getting-help.adoc | 8 +++-----
pve-installation.adoc | 4 ++--
pve-intro.adoc | 4 ++--
system-software-updates.adoc | 4 ++--
5 files changed, 13 insertions(+), 11 deletions(-)
diff --git a/attributes.txt b/attributes.txt
index f0fe7ca..7ab1fa3 100644
--- a/attributes.txt
+++ b/attributes.txt
@@ -2,6 +2,10 @@
:copyright: {proxmoxGmbh}
:pve: Proxmox VE
:website: http://www.proxmox.com/
+:forum-url: https://forum.proxmox.com/
+:forum: https://forum.proxmox.com/[{pve} Community Forum]
+:webwiki-url: https://pve.proxmox.com/wiki/
+:webwiki: https://pve.proxmox.com/wiki/[{pve} Wiki]
:manmanual: {pve} Documentation
:max-width: 55em
ifndef::docinfo1[]
diff --git a/getting-help.adoc b/getting-help.adoc
index 180a212..6da0179 100644
--- a/getting-help.adoc
+++ b/getting-help.adoc
@@ -6,17 +6,15 @@ include::attributes.txt[]
Proxmox VE Wiki
~~~~~~~~~~~~~~~
-The primary source of information is the {pve}
-http://pve.proxmox.com[wiki]. It combines the reference documentaion
-with user contributed content.
+The primary source of information is the {webwiki}. It combines the reference
+documentation with user contributed content.
Community Support Forum
~~~~~~~~~~~~~~~~~~~~~~~
{pve} itself is fully open source, so we always encourage our users to
-discuss and share their knowledge using the
-http://forum.proxmox.com/[Community Support Forum]. The forum is fully
+discuss and share their knowledge using the {forum}. The forum is fully
moderated by the Proxmox support team, and has a quite large user base
around the whole world. Needless to say that such a large forum is a
great place to get information.
diff --git a/pve-installation.adoc b/pve-installation.adoc
index cf32851..b49b866 100644
--- a/pve-installation.adoc
+++ b/pve-installation.adoc
@@ -168,8 +168,8 @@ apt-get update
apt-get install proxmox-ve
----
-You can find a detailed step by step howto on the {pve}
-http://pve.proxmox.com/wiki/Install_Proxmox_VE_on_Debian_Jessie[wiki].
+You can find a detailed step by step howto on the
+{webwiki-url}Install_Proxmox_VE_on_Debian_Jessie[wiki].
endif::wiki[]
diff --git a/pve-intro.adoc b/pve-intro.adoc
index 703f43c..f0793b7 100644
--- a/pve-intro.adoc
+++ b/pve-intro.adoc
@@ -271,5 +271,5 @@ article and is an interesting foray in the development of a large
opensource project.
NOTE: If you are interested in working on the {pve} codebase, the
-https://pve.proxmox.com/wiki/Developer_Documentation[Developer
-Documentation] wiki article will show you where to start.
+{webwiki-url}Developer_Documentation[Developer Documentation] wiki
+article will show you where to start.
diff --git a/system-software-updates.adoc b/system-software-updates.adoc
index 78cd3fd..82281b4 100644
--- a/system-software-updates.adoc
+++ b/system-software-updates.adoc
@@ -15,8 +15,8 @@ additional information.
You should do such updates at regular intervals, or when we release
versions with security related fixes. Major system upgrades are
-announced at the https://forum.proxmox.com/[Forum]. Those announcement
-also contain detailed upgrade instructions.
+announced at the {forum}. Those announcement also contain detailed
+upgrade instructions.
TIP: We recommend to run regular upgrades, because it is important to
get the latest security updates.
--
2.1.4
More information about the pve-devel
mailing list