Skip to content

Commit c809256

Browse files
Use params shortcode to access global parameters from content
Ticket: ENT-13254 Signed-off-by: Ihor Aleksandrychiev <ihor.aleksandrychiev@northern.tech>
1 parent 1108d71 commit c809256

File tree

10 files changed

+27
-27
lines changed

10 files changed

+27
-27
lines changed

cheatsheet.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -580,7 +580,7 @@ three dashes at the top) or in
580580
[\_config.yaml](https://github.com/cfengine/documentation/blob/master/generator/_config.yml)
581581
can be used directly within markdown.
582582

583-
For example this is the '{{site.CFE_manuals_version}}' version of the
583+
For example this is the '{{< params "CFE_manuals_version" >}}' version of the
584584
documentation. That variable comes from \_config.yaml.
585585

586586
Since liquid variables look a lot like mustache variables any time you want to
@@ -609,7 +609,7 @@ site.CFE_manuals_version {{ site.CFE_manuals_version }}
609609
"sort":"Host name",
610610
"filter":{
611611
"CFEngine version":{
612-
"not_match":"{{site.cfengine.branch}}.0"
612+
"not_match":"{{< params "cfengine.branch" >}}.0"
613613
}
614614
},
615615
"select":[

content/getting-started/installation/general-installation/installation-community.markdown

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ It also provides instructions for the following:
2424

2525
Once `cf-remote` is installed from the Python Package Index (e.g. `pipx install cf-remote`), execute it against a host (either local or remote).
2626

27-
For example, here we install CFEngine Community {{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}} on two hosts and bootstrap to one of them:
27+
For example, here we install CFEngine Community {{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}} on two hosts and bootstrap to one of them:
2828

2929
```command
30-
cf-remote --version={{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}} install --edition community --clients 192.168.56.13,192.168.56.14 --bootstrap 192.168.56.13
30+
cf-remote --version={{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}} install --edition community --clients 192.168.56.13,192.168.56.14 --bootstrap 192.168.56.13
3131
```
3232

3333
## 1. Download packages
@@ -59,37 +59,37 @@ Choose the right command for your operating system:
5959
**Newer 64-bit RPM based distributions: (Redhat/CentOS/SUSE)**
6060

6161
```command
62-
sudo rpm -i cfengine-community-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.el6.x86_64.rpm
62+
sudo rpm -i cfengine-community-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.el6.x86_64.rpm
6363
```
6464

6565
**Older 64-bit RPM based distributions: (Redhat/CentOS/SUSE)** (not recommended for policy server)
6666

6767
```command
68-
sudo rpm -i cfengine-community-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.el4.x86_64.rpm
68+
sudo rpm -i cfengine-community-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.el4.x86_64.rpm
6969
```
7070

7171
**32-bit RPM based distributions: (Redhat/CentOS/SUSE)** (not recommended for policy server)
7272

7373
```command
74-
sudo rpm -i cfengine-community-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.el4.i386.rpm
74+
sudo rpm -i cfengine-community-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.el4.i386.rpm
7575
```
7676

7777
**Newer 64-bit DEB based distributions: (Ubuntu/Debian)**
7878

7979
```command
80-
sudo dpkg -i cfengine-community_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_amd64-debian7.deb
80+
sudo dpkg -i cfengine-community_{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}_amd64-debian7.deb
8181
```
8282

8383
**Older 64-bit DEB based distributions: (Ubuntu/Debian)** (not recommended for policy server)
8484

8585
```command
86-
sudo dpkg -i cfengine-community_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_amd64-debian4.deb
86+
sudo dpkg -i cfengine-community_{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}_amd64-debian4.deb
8787
```
8888

8989
**32-bit DEB based distributions: (Ubuntu/Debian)** (not recommended for policy server)
9090

9191
```command
92-
sudo dpkg -i cfengine-community_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_i386-debian4.deb
92+
sudo dpkg -i cfengine-community_{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}_i386-debian4.deb
9393
```
9494

9595
**Note:** You might get a message like this: "Policy is not found in /var/cfengine/inputs, not starting CFEngine." Do not worry;

content/getting-started/installation/general-installation/installation-coreos.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Download the file-system image package for CoreOS from the [Enterprise Downloads
1717
1. On the CoreOS Host, extract the `fs-img-pkg.tar.gz` archive:
1818

1919
```command
20-
tar xvf cfengine-nova-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.x86_64.fs-img.pkg.tar.gz
20+
tar xvf cfengine-nova-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.x86_64.fs-img.pkg.tar.gz
2121
```
2222

2323
2. On the CoreOS Host, run the install script:
2424

2525
```command
26-
sudo ./cfengine-nova-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.x86_64.fs-img.pkg/install.sh
26+
sudo ./cfengine-nova-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.x86_64.fs-img.pkg/install.sh
2727
```
2828

2929
Note: Install actions logged to `/var/log/CFEngine-Install.log`.

content/getting-started/installation/general-installation/installation-enterprise-generic-tarball.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ First download the binary onto the host.
1212
Next unpack the archive. For the 64 bit tarball use:
1313

1414
```command
15-
tar --gunzip --extract --directory / --file ./cfengine-nova-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.x86_64.pkg.tar.gz
15+
tar --gunzip --extract --directory / --file ./cfengine-nova-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.x86_64.pkg.tar.gz
1616
```
1717

1818
Otherwise, for 32 bit tarball, use:
1919

2020
```command
21-
tar --gunzip --extract --directory / --file ./cfengine-nova-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.i386.pkg.tar.gz
21+
tar --gunzip --extract --directory / --file ./cfengine-nova-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.i386.pkg.tar.gz
2222
```
2323

2424
Generate a keypair for the client:

content/getting-started/installation/general-installation/installation-enterprise-vagrant.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,16 +55,16 @@ virtualbox.org. After downloading VirtualBox, install it on your computer.
5555
**Note:** To avoid problems, disable other virtualization environments you are
5656
running.
5757

58-
## Start the CFEngine Enterprise {{site.CFE_manuals_version}} Vagrant environment
58+
## Start the CFEngine Enterprise {{< params "CFE_manuals_version" >}} Vagrant environment
5959

6060
Step 1. Download our ready-made Vagrant project
61-
[tar-file](https://cfengine-package-repos.s3.amazonaws.com/enterprise/Enterprise-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}/misc/CFEngine_Enterprise_vagrant_quickstart-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.tar.gz).
61+
[tar-file](https://cfengine-package-repos.s3.amazonaws.com/enterprise/Enterprise-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}/misc/CFEngine_Enterprise_vagrant_quickstart-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.tar.gz).
6262

6363
Step 2. Save and unpack the file anywhere on your drive; this
6464
creates a Vagrant Project directory.
6565

6666
Step 3. Open a terminal and navigate to the Vagrant Project directory (e.g.
67-
`/home/user/CFEngine_Enterprise_vagrant_quickstart-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}`, or `C:\CFEngine_Enterprise_vagrant_quickstart-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}`) and enter the following command:
67+
`/home/user/CFEngine_Enterprise_vagrant_quickstart-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}`, or `C:\CFEngine_Enterprise_vagrant_quickstart-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}`) and enter the following command:
6868

6969
```command
7070
vagrant up
@@ -124,7 +124,7 @@ Last login: Fri Jun 13 18:58:10 2014 from 10.0.2.2
124124
#### Accessing via GUI
125125

126126
If you launch the virtualbox GUI you should find the vagrant vms named
127-
`CFEngine Enterprise {{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}} hub`, and `CFEngine Enterprise {{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}} agent host001`. Additionally, you can uncomment the `v.gui=true`
127+
`CFEngine Enterprise {{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}} hub`, and `CFEngine Enterprise {{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}} agent host001`. Additionally, you can uncomment the `v.gui=true`
128128
option in the `Vagrantfile` to have the console gui start with the vms.
129129
**Note:** There are two `v.gui` settings to uncomment; one for the hub, and one
130130
for the clients.

content/getting-started/installation/upgrading.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sorting: 30
55
---
66

77
This guide documents our recommendation on how to upgrade an existing
8-
installation of CFEngine Enterprise to {{site.CFE_manuals_version}}. Community users
8+
installation of CFEngine Enterprise to {{< params "CFE_manuals_version" >}}. Community users
99
can use these instructions as a guide skipping the parts that are not relevant.
1010

1111
In short, the steps are:
@@ -138,14 +138,14 @@ empty before performing an Enterprise Hub binary upgrade.
138138

139139
```console
140140
root@hub:~# export BACKUP_DIR="/mnt/plenty-of-free-space"
141-
root@hub:~# rpm -U cfengine-nova-hub-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.el6.x86_64.rpm
141+
root@hub:~# rpm -U cfengine-nova-hub-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.el6.x86_64.rpm
142142
```
143143

144144
**Debian/Ubuntu:**
145145

146146
```console
147147
root@hub:~# export BACKUP_DIR="/mnt/plenty-of-free-space"
148-
root@hub:~# dpkg --install cfengine-nova-hub_{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}_amd64-deb7.deb
148+
root@hub:~# dpkg --install cfengine-nova-hub_{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}_amd64-deb7.deb
149149
```
150150

151151
_Community does not have a hub specific package._
@@ -209,7 +209,7 @@ empty before performing an Enterprise Hub binary upgrade.
209209
"sort":"Host name",
210210
"filter":{
211211
"CFEngine version":{
212-
"not_match":"{{site.cfengine.branch}}.0"
212+
"not_match":"{{< params "cfengine.branch" >}}.0"
213213
}
214214
},
215215
"select":[

content/reference/functions/_index.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ cf-promises --syntax-description json | jq '.functions | with_entries(select(.va
107107
- `hubknowledge()`, and `remotescalar()` for hub queries
108108

109109
When enabled
110-
[cached functions](https://docs.cfengine.com/docs/{{site.cfengine.branch}}/search.html?q=The+return+value+is+cached)
110+
[cached functions](https://docs.cfengine.com/docs/{{< params "cfengine.branch" >}}/search.html?q=The+return+value+is+cached)
111111
are **not executed on every pass of convergence**. Instead, the function will
112112
only be executed once during the
113113
[agent evaluation step][Policy evaluation#Agent evaluation step]

content/release-notes/_index.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sorting: 30
55
---
66

77
- [New in CFEngine][New in CFEngine]
8-
Learn about the newest features in CFEngine {{site.CFE_manuals_version}}
8+
Learn about the newest features in CFEngine {{< params "CFE_manuals_version" >}}
99

1010
- [Supported platforms and versions][Supported platforms and versions]
1111
These are the supported platforms for the current release.

content/release-notes/known-issues.markdown

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ sorting: 50
77
CFEngine defects are managed in our [bug tracker][bug tracker].
88
Please report bugs or unexpected behavior there, following the documented guideline for new bug reports.
99

10-
- Issues [affecting {{site.CFE_manuals_version}}](https://northerntech.atlassian.net/issues/?jql=project+in+%28ENT%2C+CFE%29+AND+affectedVersion+%7E+%22{{site.CFE_manuals_version}}.*%22+AND+status+not+in+%28+%22Rejected%22%29)
11-
- Issues [fixed in {{site.CFE_manuals_version}}](https://northerntech.atlassian.net/issues/?jql=project+in+%28ENT%2C+CFE%29+AND+fixVersion+%7E+%22{{site.CFE_manuals_version}}.*%22)
10+
- Issues [affecting {{< params "CFE_manuals_version" >}}](https://northerntech.atlassian.net/issues/?jql=project+in+%28ENT%2C+CFE%29+AND+affectedVersion+%7E+%22{{< params "CFE_manuals_version" >}}.\*%22+AND+status+not+in+%28+%22Rejected%22%29)
11+
- Issues [fixed in {{< params "CFE_manuals_version" >}}](https://northerntech.atlassian.net/issues/?jql=project+in+%28ENT%2C+CFE%29+AND+fixVersion+%7E+%22{{< params "CFE_manuals_version" >}}.\*%22)
1212

1313
On this page (below) we will only mention a subset of known issues, which are very severe or noticeable, which we'd like to communicate with users.
1414

content/resources/faq/manual-execution.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ between).
6060
Sometimes it's convenient to run `cf-execd` with `--once`. It will execute
6161
`exec_command` as defined in `body executor control`. In the
6262
[Masterfiles Policy Framework][Masterfiles Policy Framework] this
63-
[defaults](https://github.com/cfengine/masterfiles/blob/{{site.cfengine.branch}}/controls/cf_execd.cf)
63+
[defaults](https://github.com/cfengine/masterfiles/blob/{{< params "cfengine.branch" >}}/controls/cf_execd.cf)
6464
to update policy ( `update.cf` ) followed by the default policy ( `promises.cf`
6565
). Output from cf-execd executions is logged to
6666
`$(sys.workdir)/outputs`.

0 commit comments

Comments
 (0)