Skip to content

Commit 14b53b6

Browse files
akimdjoaofnfernandes
authored andcommitted
Jekyll: don't put {% raw %} directives in pre blocks
Replace all occurrences of ```foo {% raw %} bar {% endraw %} ``` (which generates spurious empty lines in the rendered pre block) with {% raw %} ```foo bar ``` {% endraw %} Also, fix some occurrences where the raw section is too large and prevented interpretation of Jekyll directives. This is the syntax used in the documentation of Jekyll itself: https://raw.githubusercontent.com/jekyll/jekyll/master/docs/_docs/templates.md FTR, done with two perl substitutions: '^([\t ]*```[^\n]* )([ \t]*\{% raw %\}[^\n]* )' '$2$1' and '^([ \t]*\{% endraw %\}[^\n]* )([\t ]*```[^\n]* )' '$2$1' and manually tweaks. A mechanical check would be most useful. Signed-off-by: Akim Demaille <[email protected]>
1 parent d99b2b4 commit 14b53b6

File tree

33 files changed

+90
-95
lines changed

33 files changed

+90
-95
lines changed

config/containers/logging/configure.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ To find the current logging driver for a running container, if the daemon
8282
is using the `json-file` logging driver, run the following `docker inspect`
8383
command, substituting the container name or ID for `<CONTAINER>`:
8484

85-
```bash
8685
{% raw %}
86+
```bash
8787
$ docker inspect -f '{{.HostConfig.LogConfig.Type}}' <CONTAINER>
8888

8989
json-file
90-
{% endraw %}
9190
```
91+
{% endraw %}
9292

9393
## Configure the delivery mode of log messages from container to log driver
9494

config/containers/logging/splunk.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ The path to the root certificate and Common Name is specified using an HTTPS
8383
scheme. This is used for verification. The `SplunkServerDefaultCert` is
8484
automatically generated by Splunk certificates.
8585

86-
```bash
8786
{% raw %}
87+
```bash
8888
$ docker run --log-driver=splunk \
8989
--log-opt splunk-token=176FCEBF-4CF5-4EDF-91BC-703796522D20 \
9090
--log-opt splunk-url=https://splunkhost:8088 \
@@ -96,8 +96,8 @@ $ docker run --log-driver=splunk \
9696
--env "TEST=false" \
9797
--label location=west \
9898
your/application
99-
{% endraw %}
10099
```
100+
{% endraw %}
101101

102102
The `splunk-url` for Splunk instances hosted on Splunk Cloud is in a format
103103
like `https://http-inputs-XXXXXXXX.splunkcloud.com` and does not include a

datacenter/dtr/2.2/guides/admin/monitor-and-troubleshoot/troubleshoot-with-logs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ DTR replica to check the DTR internal state.
4949
Use SSH to log into a node that is running a DTR replica, and run the following
5050
commands:
5151

52-
```bash
5352
{% raw %}
53+
```bash
5454
# REPLICA_ID will be the replica ID for the current node.
5555
REPLICA_ID=$(docker ps -lf name='^/dtr-rethinkdb-.{12}$' --format '{{.Names}}' | cut -d- -f3)
5656
# This command will start a RethinkDB client attached to the database
@@ -59,8 +59,8 @@ docker run -it --rm \
5959
--net dtr-ol \
6060
-v dtr-ca-$REPLICA_ID:/ca dockerhubenterprise/rethinkcli:v2.2.0 \
6161
$REPLICA_ID
62-
{% endraw %}
6362
```
63+
{% endraw %}
6464

6565
This container connects to the local DTR replica and launches a RethinkDB client
6666
that can be used to inspect the contents of the DB. RethinkDB

datacenter/dtr/2.3/guides/admin/backups-and-disaster-recovery.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -66,12 +66,11 @@ you can backup the images by using ssh to log into a node where DTR is running,
6666
and creating a tar archive of the [dtr-registry volume](../architecture.md):
6767

6868
```none
69-
{% raw %}
7069
sudo tar -cf {{ image_backup_file }} \
71-
$(dirname $(docker volume inspect --format '{{.Mountpoint}}' dtr-registry-<replica-id>))
72-
{% endraw %}
70+
{% raw %}$(dirname $(docker volume inspect --format '{{.Mountpoint}}' dtr-registry-<replica-id>)){% endraw %}
7371
```
7472

73+
7574
If you're using a different storage backend, follow the best practices
7675
recommended for that system.
7776

datacenter/dtr/2.3/guides/admin/configure/external-storage/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,16 @@ same images.
5151
To check how much space your images are taking in the local filesystem, you
5252
can ssh into the node where DTR is deployed and run:
5353

54-
```
5554
{% raw %}
55+
```
5656
# Find the path to the volume
5757
docker volume inspect dtr-registry-<replica-id>
5858
5959
# Check the disk usage
6060
sudo du -hs \
6161
$(dirname $(docker volume inspect --format '{{.Mountpoint}}' dtr-registry-<dtr-replica>))
62-
{% endraw %}
6362
```
63+
{% endraw %}
6464

6565
## NFS
6666

datacenter/dtr/2.3/guides/admin/monitor-and-troubleshoot/troubleshoot-with-logs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ DTR replica to check the DTR internal state.
4949
Use SSH to log into a node that is running a DTR replica, and run the following
5050
commands:
5151

52-
```bash
5352
{% raw %}
53+
```bash
5454
# REPLICA_ID will be the replica ID for the current node.
5555
REPLICA_ID=$(docker ps -lf name='^/dtr-rethinkdb-.{12}$' --format '{{.Names}}' | cut -d- -f3)
5656
# This command will start a RethinkDB client attached to the database
@@ -59,8 +59,8 @@ docker run -it --rm \
5959
--net dtr-ol \
6060
-v dtr-ca-$REPLICA_ID:/ca dockerhubenterprise/rethinkcli:v2.2.0 \
6161
$REPLICA_ID
62-
{% endraw %}
6362
```
63+
{% endraw %}
6464

6565
This container connects to the local DTR replica and launches a RethinkDB client
6666
that can be used to inspect the contents of the DB. RethinkDB

datacenter/dtr/2.4/guides/admin/backups-and-disaster-recovery.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ and creating a tar archive of the [dtr-registry volume](../architecture.md):
6767

6868
```none
6969
sudo tar -cf {{ image_backup_file }} \
70-
{% raw %}$(dirname $(docker volume inspect --format '{{.Mountpoint}}' dtr-registry-<replica-id>)){% endraw %}
70+
{% raw %}$(dirname $(docker volume inspect --format '{{.Mountpoint}}' dtr-registry-<replica-id>)){% endraw %}
7171
```
7272

7373
If you're using a different storage backend, follow the best practices

datacenter/dtr/2.4/guides/admin/configure/external-storage/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,16 @@ same images.
5151
To check how much space your images are taking in the local filesystem, you
5252
can ssh into the node where DTR is deployed and run:
5353

54-
```
5554
{% raw %}
55+
```
5656
# Find the path to the volume
5757
docker volume inspect dtr-registry-<replica-id>
5858
5959
# Check the disk usage
6060
sudo du -hs \
6161
$(dirname $(docker volume inspect --format '{{.Mountpoint}}' dtr-registry-<dtr-replica>))
62-
{% endraw %}
6362
```
63+
{% endraw %}
6464

6565
## NFS
6666

datacenter/dtr/2.4/guides/admin/monitor-and-troubleshoot/troubleshoot-with-logs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ DTR replica to check the DTR internal state.
4949
Use SSH to log into a node that is running a DTR replica, and run the following
5050
commands:
5151

52-
```bash
5352
{% raw %}
53+
```bash
5454
# This command will start a RethinkDB client attached to the database
5555
# on the current node.
5656
docker exec -it $(docker ps -q --filter name=dtr-rethinkdb) rethinkcli
57-
{% endraw %}
5857
```
58+
{% endraw %}
5959

6060
RethinkDB stores data in different databases that contain multiple tables. The `rethinkcli`
6161
tool launches an interactive prompt where you can run RethinkDB

datacenter/ucp/2.0/guides/access-ucp/cli-based-access.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ To verify a client certificate bundle has been loaded and the client is
5656
successfully communicating with UCP, look for `ucp` in the `Server Version`
5757
returned by `docker version`.
5858

59-
```bash
6059
{% raw %}
60+
```bash
6161
$ docker version --format '{{.Server.Version}}'
62-
{% endraw %}
6362
ucp/2.0.0
6463
```
64+
{% endraw %}
6565

6666
From now on, when you use the Docker CLI client, it includes your client
6767
certificates as part of the request to the Docker Engine.

datacenter/ucp/2.1/guides/admin/configure/add-sans-to-cluster.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ that join the cluster.
3737

3838
You can also do this from the CLI by first running:
3939

40-
```bash
4140
{% raw %}
41+
```bash
4242
$ docker node inspect --format '{{ index .Spec.Labels "com.docker.ucp.SANs" }}' <node-id>
4343
default-cs,127.0.0.1,172.17.0.1
44-
{% endraw %}
4544
```
45+
{% endraw %}
4646

4747
This gets the current set of SANs for the given manager node. Append your
4848
desired SAN to this list. For example, `default-cs,127.0.0.1,172.17.0.1,example.com`.

datacenter/ucp/2.1/guides/admin/manage-users/recover-a-user-password.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ with administrator credentials to change your password.
1919
If you're the only administrator, use **ssh** to log in to a manager
2020
node managed by UCP, and run:
2121

22-
```none
2322
{% raw %}
23+
```none
2424
docker exec -it ucp-auth-api enzi \
2525
"$(docker inspect --format '{{ index .Args 0 }}' ucp-auth-api)" \
2626
passwd -i
27-
{% endraw %}
2827
```
28+
{% endraw %}

datacenter/ucp/2.1/guides/admin/monitor-and-troubleshoot/troubleshoot-configurations.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -88,22 +88,22 @@ The examples below assume you are logged in with ssh into a UCP manager node.
8888

8989
### Check the status of the database
9090

91-
```bash
9291
{% raw %}
92+
```bash
9393
# NODE_ADDRESS will be the IP address of this Docker Swarm manager node
9494
NODE_ADDRESS=$(docker info --format '{{.Swarm.NodeAddr}}')
9595
# VERSION will be your most recent version of the docker/ucp-auth image
9696
VERSION=$(docker image ls --format '{{.Tag}}' docker/ucp-auth | head -n 1)
9797
# This command will output detailed status of all servers and database tables
9898
# in the RethinkDB cluster.
9999
docker run --rm -v ucp-auth-store-certs:/tls docker/ucp-auth:${VERSION} --db-addr=${NODE_ADDRESS}:12383 db-status
100-
{% endraw %}
101100
```
101+
{% endraw %}
102102

103103
### Manually reconfigure database replication
104104

105-
```bash
106105
{% raw %}
106+
```bash
107107
# NODE_ADDRESS will be the IP address of this Docker Swarm manager node
108108
NODE_ADDRESS=$(docker info --format '{{.Swarm.NodeAddr}}')
109109
# NUM_MANAGERS will be the current number of manager nodes in the cluster
@@ -113,8 +113,8 @@ VERSION=$(docker image ls --format '{{.Tag}}' docker/ucp-auth | head -n 1)
113113
# This reconfigure-db command will repair the RethinkDB cluster to have a
114114
# number of replicas equal to the number of manager nodes in the cluster.
115115
docker run --rm -v ucp-auth-store-certs:/tls docker/ucp-auth:${VERSION} --db-addr=${NODE_ADDRESS}:12383 --debug reconfigure-db --num-replicas ${NUM_MANAGERS} --emergency-repair
116-
{% endraw %}
117116
```
117+
{% endraw %}
118118

119119
## Where to go next
120120

datacenter/ucp/2.1/guides/user/access-ucp/cli-based-access.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ To verify a client certificate bundle has been loaded and the client is
5656
successfully communicating with UCP, look for `ucp` in the `Server Version`
5757
returned by `docker version`.
5858

59-
```bash
6059
{% raw %}
60+
```bash
6161
$ docker version --format '{{.Server.Version}}'
62-
{% endraw %}
6362
ucp/2.1.0
6463
```
64+
{% endraw %}
6565

6666
From now on, when you use the Docker CLI client, it includes your client
6767
certificates as part of the request to the Docker Engine.

datacenter/ucp/2.2/guides/access-control/recover-a-user-password.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ with administrator credentials to change your password.
2323
If you're the only administrator, use **ssh** to log in to a manager
2424
node managed by UCP, and run:
2525

26-
```none
2726
{% raw %}
27+
```none
2828
docker exec -it ucp-auth-api enzi \
2929
$(docker inspect --format '{{range .Args}}{{if eq "--db-addr=" (printf "%.10s" .)}}{{.}}{{end}}{{end}}' ucp-auth-api) \
3030
passwd -i
31-
{% endraw %}
3231
```
32+
{% endraw %}

datacenter/ucp/2.2/guides/admin/configure/add-sans-to-cluster.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ that join the swarm.
3636

3737
You can also do this from the CLI by first running:
3838

39-
```bash
4039
{% raw %}
40+
```bash
4141
$ docker node inspect --format '{{ index .Spec.Labels "com.docker.ucp.SANs" }}' <node-id>
4242
default-cs,127.0.0.1,172.17.0.1
43-
{% endraw %}
4443
```
44+
{% endraw %}
4545

4646
This will get the current set of SANs for the given manager node. Append your
4747
desired SAN to this list, for example `default-cs,127.0.0.1,172.17.0.1,example.com`,

datacenter/ucp/2.2/guides/admin/configure/external-auth/enable-ldap-config-file.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@ $ docker container run --rm {{ page.ucp_org }}/{{ page.ucp_repo }}:{{ page.ucp_v
2323
1. Use the following command to extract the name of the currently active
2424
configuration from the `ucp-agent` service.
2525

26-
```bash
2726
{% raw %}
27+
```bash
2828
$ CURRENT_CONFIG_NAME=$(docker service inspect --format '{{ range $config := .Spec.TaskTemplate.ContainerSpec.Configs }}{{ $config.ConfigName }}{{ "\n" }}{{ end }}' ucp-agent | grep 'com.docker.ucp.config-')
29-
{% endraw %}
3029
```
30+
{% endraw %}
3131

3232
2. Get the current configuration and save it to a TOML file.
3333

34-
```bash
3534
{% raw %}
35+
```bash
3636
$ docker config inspect --format '{{ printf "%s" .Spec.Data }}' $CURRENT_CONFIG_NAME > config.toml
37-
{% endraw %}
3837
```
38+
{% endraw %}
3939

4040
3. Use the output of the `example-config` command as a guide to edit your
4141
`config.toml` file. Under the `[auth]` sections, set `backend = "ldap"`

datacenter/ucp/2.2/guides/admin/configure/ucp-configuration-file.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ number that increases with each version, like `com.docker.ucp.config-1`. The
3333
Use the `docker config inspect` command to view the current settings and emit
3434
them to a file.
3535

36-
```bash
3736
{% raw %}
37+
```bash
3838
# CURRENT_CONFIG_NAME will be the name of the currently active UCP configuration
3939
CURRENT_CONFIG_NAME=$(docker service inspect ucp-agent --format '{{range .Spec.TaskTemplate.ContainerSpec.Configs}}{{if eq "/etc/ucp/ucp.toml" .File.Name}}{{.ConfigName}}{{end}}{{end}}')
4040
# Collect the current config with `docker config inspect`
4141
docker config inspect --format '{{ printf "%s" .Spec.Data }}' $CURRENT_CONFIG_NAME > ucp-config.toml
42-
{% endraw %}
4342
```
43+
{% endraw %}
4444

4545
Edit the file, then use the `docker config create` and `docker service update`
4646
commands to create and apply the configuration from the file.

datacenter/ucp/2.2/guides/admin/install/architecture-specific-images.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,7 @@ a [UCP support dump](..\..\get-support.md) to use an environment variable
1717
that indicates the current architecture:
1818

1919
```bash
20-
{% raw %}
21-
[[ $(docker info --format='{{.Architecture}}') == s390x ]] && export _ARCH='-s390x' || export _ARCH=''
22-
{% endraw %}
20+
{% raw %}[[ $(docker info --format='{{.Architecture}}') == s390x ]] && export _ARCH='-s390x' || export _ARCH=''{% endraw %}
2321

2422
docker container run --rm \
2523
--name ucp \

datacenter/ucp/2.2/guides/admin/monitor-and-troubleshoot/troubleshoot-configurations.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@ The examples below assume you are logged in with ssh into a UCP manager node.
9191

9292
### Check the status of the database
9393

94-
```bash
9594
{% raw %}
95+
```bash
9696
# NODE_ADDRESS will be the IP address of this Docker Swarm manager node
9797
NODE_ADDRESS=$(docker info --format '{{.Swarm.NodeAddr}}')
9898
# VERSION will be your most recent version of the docker/ucp-auth image
@@ -117,13 +117,13 @@ Server Status: [
117117
}
118118
]
119119
...
120-
{% endraw %}
121120
```
121+
{% endraw %}
122122

123123
### Manually reconfigure database replication
124124

125-
```bash
126125
{% raw %}
126+
```bash
127127
# NODE_ADDRESS will be the IP address of this Docker Swarm manager node
128128
NODE_ADDRESS=$(docker info --format '{{.Swarm.NodeAddr}}')
129129
# NUM_MANAGERS will be the current number of manager nodes in the cluster
@@ -140,8 +140,8 @@ time="2017-07-14T20:46:09Z" level=debug msg="Reconfiguring number of replicas to
140140
time="2017-07-14T20:46:09Z" level=debug msg="(00/16) Emergency Repairing Tables..."
141141
time="2017-07-14T20:46:09Z" level=debug msg="(01/16) Emergency Repaired Table \"grant_objects\""
142142
...
143-
{% endraw %}
144143
```
144+
{% endraw %}
145145

146146
## Where to go next
147147

datacenter/ucp/2.2/guides/user/access-ucp/cli-based-access.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,7 @@ successfully communicating with UCP, look for `ucp` in the `Server Version`
6161
returned by `docker version`.
6262

6363
```bash
64-
{% raw %}
65-
docker version --format '{{.Server.Version}}'
66-
{% endraw %}
64+
{% raw %}docker version --format '{{.Server.Version}}'{% endraw %}
6765
{{ page.ucp_repo }}/{{ page.ucp_version }}
6866
```
6967

docker-for-aws/iam-permissions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ For instructions, see [Link Amazon Web Services to Docker Cloud](/docker-cloud/c
1414
This feature is called [AWS CloudFormation Service Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-servicerole.html?icmpid=docs_cfn_console)
1515
follow the link for more information.
1616

17-
```none
1817
{% raw %}
18+
```none
1919
{
2020
"Version": "2012-10-17",
2121
"Statement": [
@@ -343,5 +343,5 @@ follow the link for more information.
343343
}
344344
]
345345
}
346-
{% endraw %}
347346
```
347+
{% endraw %}

0 commit comments

Comments
 (0)