Skip to content

Commit 05be75b

Browse files
Merge branch 'main' into HennaAbbas-patch-1
2 parents d6f3619 + a6931fb commit 05be75b

File tree

4 files changed

+26
-9
lines changed

4 files changed

+26
-9
lines changed

.vale.ini

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,8 @@ experimental = YES
1818
attribute-missing = drop
1919

2020
[*.adoc]
21-
BasedOnStyles = circleci-docs, Vale, Readability, Openly, AsciiDoc
21+
BasedOnStyles = circleci-docs, Vale, Readability, Openly, AsciiDoc
22+
23+
[**/nav.adoc]
24+
circleci-docs.XrefTitleCase = NO
25+
circleci-docs.ListPunctuation = NO

docs/guides/modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@
119119
*** xref:execution-runner:install-machine-runner-3-on-linux.adoc[Install machine runner 3 on Linux]
120120
*** xref:execution-runner:install-machine-runner-3-on-macos.adoc[Install machine runner 3 on macOS]
121121
*** xref:execution-runner:install-machine-runner-3-on-windows.adoc[Install machine runner 3 on Windows]
122-
*** xref:execution-runner:install-machine-runner-3-on-docker.adoc[Install on Docker]
122+
*** xref:execution-runner:install-machine-runner-3-on-docker.adoc[Install machine runner 3 on Docker]
123123
*** xref:execution-runner:machine-runner-3-manual-installation.adoc[Manual install on Linux and macOS]
124124
*** xref:execution-runner:machine-runner-3-manual-installation-on-windows.adoc[Manual install on Windows]
125125
*** xref:execution-runner:migrate-from-launch-agent-to-machine-runner-3-on-linux.adoc[Migrate from launch agent to machine runner 3 on Linux]

docs/guides/modules/execution-runner/pages/install-machine-runner-3-on-docker.adoc

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
This page describes how to install CircleCI's machine runner 3 with the Docker executor. If you are looking to set up self-hosted runners in a private Kubernetes cluster, visit the <<container-runner-installation#,Container runner>> page.
99

1010
****
11-
xref:container-runner.adoc[Container runner] is the **recommended method** for self-hosted runner Docker installation. The instructions on this page are for a simple Docker setup using machine runner 3.
11+
xref:container-runner.adoc[Container Runner] is the **recommended method** for self-hosted runner Docker installation. The instructions on this page are for a simple Docker setup using machine runner 3.
1212
13-
Container runner is the recommended approach for running containerized jobs on self-hosted runners. Container runner offers the ability to seamlessly define, publish, and use custom Docker images during job execution. Container runner also h as the ability to manage dependencies or libraries through custom Docker images instead of enumerating dependencies as part of `steps` in the `.circleci/config.yml` file.
13+
Container runner is the recommended approach for running containerized jobs on self-hosted runners. Container runner offers the ability to seamlessly define, publish, and use custom Docker images during job execution. Container runner also has the ability to manage dependencies or libraries through custom Docker images instead of enumerating dependencies as part of `steps` in the `.circleci/config.yml` file.
1414
****
1515

1616
[#machine-approach-with-docker]
@@ -36,7 +36,20 @@ include::ROOT:partial$runner/terms.adoc[]
3636
[#create-namespace-and-resource-class]
3737
=== 1. Create namespace and resource class
3838

39+
[tabs]
40+
====
41+
Web app installation::
42+
+
43+
--
44+
include::ROOT:partial$runner/install-with-web-app-steps.adoc[]
45+
--
46+
47+
CLI installation::
48+
+
49+
--
3950
include::ROOT:partial$runner/install-with-cli-steps.adoc[]
51+
--
52+
====
4053

4154
=== 2. Create a Dockerfile that extends the machine runner 3 image
4255

@@ -111,7 +124,7 @@ include::ROOT:partial$runner/machine-runner-example.adoc[]
111124
[#additional-resources]
112125
== Additional resources
113126

114-
- xref:install-machine-runner-3-on-linux.adoc[Machine runner 3 Linux package installation]
115-
- xref:install-machine-runner-3-on-macos.adoc[Machine runner 3 macOS Homebrew installation]
116-
- xref:install-machine-runner-3-on-windows.adoc[Machine runner 3 Windows installation]
117-
- xref:machine-runner-3-configuration-reference.adoc[Machine runner 3 configuration reference]
127+
- xref:install-machine-runner-3-on-linux.adoc[Machine Runner 3 Linux Package Installation]
128+
- xref:install-machine-runner-3-on-macos.adoc[Machine Runner 3 macOS Homebrew Installation]
129+
- xref:install-machine-runner-3-on-windows.adoc[Machine Runner 3 Windows Installation]
130+
- xref:machine-runner-3-configuration-reference.adoc[Machine Runner 3 Configuration Reference]

styles/circleci-docs/XrefTitleCase.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ script: |
1313
// Words that should not be capitalized in title case (unless first/last word)
1414
// Articles, coordinating conjunctions, and short prepositions only
1515
lowercase_words := ["a", "an", "the", "and", "but", "or", "for", "nor", "so", "yet",
16-
"at", "by", "in", "of", "on", "to", "up", "as", "via", "per"]
16+
"at", "by", "in", "of", "on", "to", "up", "as", "via", "per", "macos"]
1717
1818
for i, line in lines {
1919
// Find all xref patterns: xref:path[Link Text]

0 commit comments

Comments
 (0)