Skip to content

Commit 7ea8b1a

Browse files
authored
Merge pull request #3526 from aleksandrychev/ENT-13254
ENT-13254: Fixed variables usage in contents
2 parents 0bc9597 + 70fcbd6 commit 7ea8b1a

File tree

11 files changed

+36
-27
lines changed

11 files changed

+36
-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
@@ -26,10 +26,10 @@ It also provides instructions for the following:
2626

2727
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).
2828

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

3131
```command
32-
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
32+
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
3333
```
3434

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

6363
```command
64-
sudo rpm -i cfengine-community-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.el6.x86_64.rpm
64+
sudo rpm -i cfengine-community-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.el6.x86_64.rpm
6565
```
6666

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

6969
```command
70-
sudo rpm -i cfengine-community-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.el4.x86_64.rpm
70+
sudo rpm -i cfengine-community-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.el4.x86_64.rpm
7171
```
7272

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

7575
```command
76-
sudo rpm -i cfengine-community-{{site.cfengine.branch}}.{{site.cfengine.latest_patch_release}}-{{site.cfengine.latest_package_build}}.el4.i386.rpm
76+
sudo rpm -i cfengine-community-{{< params "cfengine.branch" >}}.{{< params "cfengine.latest_patch_release" >}}-{{< params "cfengine.latest_package_build" >}}.el4.i386.rpm
7777
```
7878

7979
**Newer 64-bit DEB based distributions: (Ubuntu/Debian)**
8080

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

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

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

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

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

9797
**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
@@ -19,13 +19,13 @@ Download the file-system image package for CoreOS from the [Enterprise Downloads
1919
1. On the CoreOS Host, extract the `fs-img-pkg.tar.gz` archive:
2020

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

2525
2. On the CoreOS Host, run the install script:
2626

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

3131
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
@@ -14,13 +14,13 @@ First download the binary onto the host.
1414
Next unpack the archive. For the 64 bit tarball use:
1515

1616
```command
17-
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
17+
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
1818
```
1919

2020
Otherwise, for 32 bit tarball, use:
2121

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

2626
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
@@ -57,16 +57,16 @@ virtualbox.org. After downloading VirtualBox, install it on your computer.
5757
**Note:** To avoid problems, disable other virtualization environments you are
5858
running.
5959

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

6262
Step 1. Download our ready-made Vagrant project
63-
[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).
63+
[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).
6464

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

6868
Step 3. Open a terminal and navigate to the Vagrant Project directory (e.g.
69-
`/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:
69+
`/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:
7070

7171
```command
7272
vagrant up
@@ -126,7 +126,7 @@ Last login: Fri Jun 13 18:58:10 2014 from 10.0.2.2
126126
#### Accessing via GUI
127127

128128
If you launch the virtualbox GUI you should find the vagrant vms named
129-
`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`
129+
`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`
130130
option in the `Vagrantfile` to have the console gui start with the vms.
131131
**Note:** There are two `v.gui` settings to uncomment; one for the hub, and one
132132
for the clients.

content/getting-started/installation/upgrading.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ aliases:
77
---
88

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

1313
In short, the steps are:
@@ -140,14 +140,14 @@ empty before performing an Enterprise Hub binary upgrade.
140140

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

146146
**Debian/Ubuntu:**
147147

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

153153
_Community does not have a hub specific package._
@@ -211,7 +211,7 @@ empty before performing an Enterprise Hub binary upgrade.
211211
"sort":"Host name",
212212
"filter":{
213213
"CFEngine version":{
214-
"not_match":"{{site.cfengine.branch}}.0"
214+
"not_match":"{{< params "cfengine.branch" >}}.0"
215215
}
216216
},
217217
"select":[

content/reference/functions/_index.markdown

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

111111
When enabled
112-
[cached functions](https://docs.cfengine.com/docs/{{site.cfengine.branch}}/search.html?q=The+return+value+is+cached)
112+
[cached functions](https://docs.cfengine.com/docs/{{< params "cfengine.branch" >}}/search.html?q=The+return+value+is+cached)
113113
are **not executed on every pass of convergence**. Instead, the function will
114114
only be executed once during the
115115
[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
@@ -7,7 +7,7 @@ aliases:
77
---
88

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

1212
- [Supported platforms and versions][Supported platforms and versions]
1313
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
@@ -9,8 +9,8 @@ aliases:
99
CFEngine defects are managed in our [bug tracker][bug tracker].
1010
Please report bugs or unexpected behavior there, following the documented guideline for new bug reports.
1111

12-
- 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)
13-
- 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)
12+
- 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" >}}.%2A%22+AND+status+not+in+%28+%22Rejected%22%29)
13+
- 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" >}}.%2A%22)
1414

1515
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.
1616

content/resources/faq/manual-execution.markdown

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

0 commit comments

Comments
 (0)