Skip to content

Commit c71ab4f

Browse files
Merge pull request circleci#8739 from circleci/fix
Style fixes
2 parents 2793f6f + 05e35f2 commit c71ab4f

File tree

4 files changed

+18
-15
lines changed

4 files changed

+18
-15
lines changed

jekyll/_cci2/runner-installation-linux.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ contentTags:
1313
:machine:
1414
:linux:
1515

16-
CAUTION: This installation method is deprecated for **CIrcleCI cloud** customers. Refer to the xref:install-machine-runner-3-on-linux#[machine runner 3.0 installation guide] for the recommended steps to set up Linux self-hosted runners on CircleCI cloud.
17-
18-
This page describes how to install CircleCI's machine runner on Linux for **CircleCI server** customers.
16+
CAUTION: This installation method is deprecated for **CircleCI cloud** customers. Refer to the xref:install-machine-runner-3-on-linux#[machine runner 3.0 installation guide] for the recommended steps to set up Linux self-hosted runners on CircleCI cloud.
17+
18+
This page describes how to install CircleCI's machine runner on Linux for **CircleCI server** customers.
1919

2020
[#prerequisites]
2121
== Prerequisites
2222

2323
To install machine runners and run jobs, you will need to have root access, and have the following utilities and tools installed on your system:
2424

25-
* https://www.gnu.org/software/coreutils/[coreutils]
25+
* https://www.gnu.org/software/coreutils/[Coreutils]
2626

2727
* https://curl.se/[curl]
2828

@@ -32,11 +32,11 @@ To install machine runners and run jobs, you will need to have root access, and
3232

3333
* https://www.gnu.org/software/tar/[tar]
3434

35-
* https://www.gnu.org/software/gzip/[gzip]
35+
* https://www.gnu.org/software/gzip/[Gzip]
3636

37-
* sepolicy (https://www.redhat.com/en/enterprise-linux-8/details[RHEL 8] only)
37+
* `sepolicy` (https://www.redhat.com/en/enterprise-linux-8/details[RHEL 8] only)
3838

39-
* rpmbuild (https://www.redhat.com/en/enterprise-linux-8/details[RHEL 8] only)
39+
* `rpmbuild` (https://www.redhat.com/en/enterprise-linux-8/details[RHEL 8] only)
4040

4141
* The xref:local-cli#[CircleCI CLI] if you wish to install runners from the command line
4242

@@ -66,7 +66,7 @@ To install machine runners and run jobs, you will need to have root access, and
6666
[#create-the-circleci-user-and-working-directory]
6767
== 3. Create `circleci` user and working directory
6868

69-
These will be used when executing the task-agent. These commands must be run as a user with permissions to create other users (e.g. `root`). For information about GECOS, see the https://en.wikipedia.org/wiki/Gecos_field[wiki page].
69+
These will be used when executing the task-agent. These commands must be run as a user with permissions to create other users (for example, `root`). For information about GECOS, see the https://en.wikipedia.org/wiki/Gecos_field[wiki page].
7070

7171
[#ubuntu-debian]
7272
=== Ubuntu/Debian
@@ -221,7 +221,7 @@ TimeoutStopSec=18300
221221
WantedBy = multi-user.target
222222
```
223223

224-
Unlike task-agents, which use the environment of the `circleci` user, launch-agents will need to have any required environment variables (e.g., proxy settings) explicitly defined in the unit configuration file. These can be set by `Environment=` or `EnvironmentFile=`. Please visit the `systemd` https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Environment[documentation] for more information.
224+
Unlike task-agents, which use the environment of the `circleci` user, launch-agents will need to have any required environment variables (for example, proxy settings) explicitly defined in the unit configuration file. These can be set by `Environment=` or `EnvironmentFile=`. Visit the `systemd` https://www.freedesktop.org/software/systemd/man/systemd.exec.html#Environment[documentation] for more information.
225225

226226
You can now enable the service:
227227

jekyll/_cci2/runner-installation-mac.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ contentTags:
1313
:machine:
1414
:macos:
1515

16-
CAUTION: This installation method is deprecated for **CIrcleCI cloud** customers. Refer to the xref:install-machine-runner-3-on-linux#[machine runner 3.0 installation guide] for the recommended steps to set up macOS self-hosted runners on CircleCI cloud.
16+
CAUTION: This installation method is deprecated for **CircleCI cloud** customers. Refer to the xref:install-machine-runner-3-on-linux#[machine runner 3.0 installation guide] for the recommended steps to set up macOS self-hosted runners on CircleCI cloud.
1717

18-
This page describes how to install CircleCI's machine runner on macOS for **CircleCI server** customers.
18+
This page describes how to install CircleCI's machine runner on macOS for **CircleCI server** customers.
1919

2020
[#prerequisites]
2121
== Prerequisites

jekyll/_cci2/runner-installation-windows.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ contentTags:
1313
:machine:
1414
:windows:
1515

16-
CAUTION: This installation method is deprecated for **CIrcleCI cloud** customers. Refer to the xref:install-machine-runner-3-on-windows#[machine runner 3.0 installation guide] for the recommended steps to set up Windows self-hosted runners on CircleCI cloud.
16+
CAUTION: This installation method is deprecated for **CircleCI cloud** customers. Refer to the xref:install-machine-runner-3-on-windows#[machine runner 3.0 installation guide] for the recommended steps to set up Windows self-hosted runners on CircleCI cloud.
1717

1818
This page describes how to install machine runner on Windows for **CircleCI server**. This has been tested for Windows Server 2019 and Windows Server 2016, both in Datacenter Edition. Other Server SKUs with Desktop Experience and Remote Desktop Services should also work.
1919

@@ -29,7 +29,7 @@ Since this setup creates a new local administrator user that runs CircleCI jobs,
2929

3030
* https://www.gnu.org/software/tar/[tar]
3131

32-
* https://www.gnu.org/software/gzip/[gzip]
32+
* https://www.gnu.org/software/gzip/[Gzip]
3333

3434
* The xref:local-cli#[CircleCI CLI] if you wish to install runners from the command line
3535

@@ -74,7 +74,7 @@ Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManage
7474
+
7575
The installation will be output into your PowerShell interface.
7676

77-
. As part of the installation, the configuration file for the machine runner (`launch-agent-config.yaml`) will open in Notepad. Please fill the file out with the requested information (see xref:runner-config-reference.adoc[Self-hosted Runner Configuration Reference]). The configuration file is located in the installation directory, `C:\Program Files\CircleCI`, by default.
77+
. As part of the installation, the configuration file for the machine runner (`launch-agent-config.yaml`) will open in Notepad. Fill the file out with the requested information (see xref:runner-config-reference.adoc[Self-hosted Runner Configuration Reference]). The configuration file is located in the installation directory, `C:\Program Files\CircleCI`, by default.
7878

7979
After setup completes, the machine runner starts automatically and begins looking for jobs to process.
8080

@@ -97,7 +97,7 @@ Uninstalling machine runners will prepare the system for installation again.
9797
[#continuous-mode-vs.-single-task-mode-for-windows-self-hosted-runners]
9898
== Continuous mode vs. single task mode for Windows self-hosted runners
9999

100-
By default, Windows machine runners run in <<runner-config-reference#runner-mode,single task mode>> in order to ensure high reliablity of the underlying technology that the self-hosted runner uses to execute jobs. This is the **recommended mode** for Windows machine runners.
100+
By default, Windows machine runners run in <<runner-config-reference#runner-mode,single task mode>> in order to ensure high reliability of the underlying technology that the self-hosted runner uses to execute jobs. This is the **recommended mode** for Windows machine runners.
101101

102102
A Windows machine runner *can* be run in `continuous` mode, however, doing so eliminates the guarantee of a clean job environment. This may translate into jobs not executing as expected and failing.
103103

styles/config/vocabularies/Docs/accept.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ Cypress
8282
Datacenter
8383
Datadog
8484
datastore
85+
Debian
8586
deduplicate
8687
deduplicated
8788
DevOps
@@ -230,6 +231,7 @@ stdin
230231
[Ss]ubshells?
231232
subcommand
232233
superset
234+
systemd
233235
TCPRoute
234236
TeamCity
235237
Telegraf
@@ -242,6 +244,7 @@ TLS
242244
[Tt]oolchains?
243245
[Tt]ruthy
244246
TypeScript
247+
Ubuntu
245248
UI
246249
UIDs?
247250
[Uu]ncheck

0 commit comments

Comments
 (0)