8000 🧹 tidy snippets and partials - round 2 (#9320) · circleci/circleci-docs@97a65fd · GitHub
[go: up one dir, main page]
Skip to content

Commit 97a65fd

Browse files
rosieyohannanrosieyohannan
authored
🧹 tidy snippets and partials - round 2 (#9320)
* tidy up some snippets * tidy more snips
1 parent 73a61fa commit 97a65fd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+290
-290
lines changed

‎jekyll/_cci2/artifacts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ If you need to restrict the connections allowed in your jobs, consider enabling
4242

4343
To upload artifacts created during builds, use the following example:
4444

45-
include::../_includes/snippets/docker-auth.adoc[]
45+
include::../_includes/partials/notes/docker-auth.adoc[]
4646

4747
[,yaml]
4848
----

‎jekyll/_cci2/browser-testing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ WebDriver can operate in two modes, local, or remote:
4040

4141
If Selenium is not included in your primary Docker image, install, and run Selenium as shown below:
4242

43-
include::../_includes/snippets/docker-auth.adoc[]
43+
include::../_includes/partials/notes/docker-auth.adoc[]
4444

4545
[,yaml]
4646
----

‎jekyll/_cci2/building-docker-images.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ NOTE: The _remote_ in "remote Docker" is a legacy term from when remote Docker u
2121

2222
To build Docker images (for example, using `docker` or `docker compose` commands) when using the Docker execution environment, you must use the `setup_remote_docker` key in your job:
2323

24-
include::../_includes/snippets/docker-auth.adoc[]
24+
include::../_includes/partials/notes/docker-auth.adoc[]
2525

2626
[,yaml]
2727
----

‎jekyll/_cci2/caching.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@ jobs:
425425
----
426426

427427

428-
include::../_includes/snippets/docker-auth.adoc[]
428+
include::../_includes/partials/notes/docker-auth.adoc[]
429429

430430
[#source-caching]
431431
== Source caching

‎jekyll/_cci2/circleci-images.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ jobs:
6363
- image: cimg/base:2021.04
6464
----
6565

66-
include::../_includes/snippets/docker-auth.adoc[]
66+
include::../_includes/partials/notes/docker-auth.adoc[]
6767

6868
`cimg/base:2021.04` is a Ubuntu-based image designed to install the bare minimum. The
6969
next-generation convenience images are based on this image.

‎jekyll/_cci2/code-coverage.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ image::artifacts.png[Artifacts tab in the web app]
2525
[#language-specific-code-coverage-options]
2626
== Language-specific code coverage options
2727

28-
include::../_includes/snippets/docker-auth.adoc[]
28+
include::../_includes/partials/notes/docker-auth.adoc[]
2929

3030
[#ruby]
3131
=== Ruby

‎jekyll/_cci2/concepts.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ image::executor_types.png[Illustration of a CircleCI job]
244244

245245
An _image_ is a packaged system that includes instructions for creating a running container or virtual machine, and you can define an image for each executor. CircleCI provides a range of images for use with the Docker executor, called _convenience images_ (details in the <<images,images>> section).
246246

247-
include::../_includes/snippets/docker-auth.adoc[]
247+
include::../_includes/partials/notes/docker-auth.adoc[]
248248

249249
[.tab.executors.Cloud]
250250
[,yaml]
@@ -338,7 +338,7 @@ An image is a packaged system that includes instructions for creating a running
338338

339339
The *Docker executor* spins up a container with a Docker image. CircleCI maintains xref:circleci-images#[convenience images] for popular languages on Docker Hub.
340340

341-
include::../_includes/snippets/docker-auth.adoc[]
341+
include::../_includes/partials/notes/docker-auth.adoc[]
342342

343343
The *machine executor* spins up a complete Ubuntu virtual machine image, giving you full access to OS resources and complete control over the job environment. For more information, see the xref:configuration-reference#machine[Using machine] page.
344344

@@ -576,7 +576,7 @@ image::/docs/assets/img/docs/workflow_detail_newui.png[Workflows illustration cl
576576

577577
The following configuration example shows a workflow called `build_and_test` in which the job `build1` runs and then jobs `build2` and `build3` run concurrently:
578578

579-
include::../_includes/snippets/docker-auth.adoc[]
579+
include::../_includes/partials/notes/docker-auth.adoc[]
580580

581581< F438 code class="diff-text syntax-highlighted-line">
[,yaml]
582582
----

‎jekyll/_cci2/concurrency.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ To run a set of concurrent jobs, you will need to add a `workflows` section to y
3737

3838
The simple example below shows the default workflow orchestration with two concurrent jobs. The `workflows` key needs to have a unique name. In this example, the unique name is `build_and_test`. The `jobs` key is nested under the uniquely named workflow, and contains the list of job names. Since the jobs have no dependencies, they will run concurrently.
3939

40-
include::../_includes/snippets/docker-auth.adoc[]
40+
include::../_includes/partials/notes/docker-auth.adoc[]
4141

4242
```yaml
4343
version: 2.1

‎jekyll/_cci2/config-intro.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ CircleCI provides an on-demand shell to run commands. In this first example, you
3535
. If you have not done so already, <<first-steps#,sign up with CircleCI>> and then either create or set up a new project. You can follow the steps to connect a code repository in our xref:getting-started#[Quickstart guide].
3636
. Once you have created or set up your project in CircleCI, go to the `.circleci/config.yml` file and replace its contents with the following code:
3737
+
38-
include::../_includes/snippets/docker-auth.adoc[]
38+
include::../_includes/partials/notes/docker-auth.adoc[]
3939
+
4040
[source,yaml]
4141
----

‎jekyll/_cci2/configuration-reference.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1276,7 +1276,7 @@ jobs:
12761276
[#x86]
12771277
====== x86
12781278

1279-
include::../_includes/snippets/docker-resource-table.adoc[]
1279+
include::../_includes/partials/execution-resources/docker-resource-table.adoc[]
12801280

12811281
[#arm]
12821282
====== Arm
@@ -1290,7 +1290,7 @@ include::../_includes/partials/execution-resources/docker-arm-resource-table.ado
12901290
[#linuxvm-execution-environment]
12911291
===== LinuxVM execution environment
12921292

1293-
include::../_includes/snippets/machine-resource-table.adoc[]
1293+
include::../_includes/partials/execution-resources/machine-resource-table.adoc[]
12941294

12951295
Example:
12961296

@@ -1326,7 +1326,7 @@ jobs:
13261326
[#macos-execution-environment]
13271327
===== macOS execution environment
13281328

1329-
include::../_includes/snippets/macos-resource-table.adoc[]
1329+
include::../_includes/partials/execution-resources/macos-resource-table.adoc[]
13301330

13311331
*Example*
13321332

@@ -1398,7 +1398,7 @@ jobs:
13981398
[#gpu-execution-environment-linux]
13991399
===== GPU execution environment (Linux)
14001400

1401-
include::../_includes/snippets/gpu-linux-resource-table.adoc[]
1401+
include::../_includes/partials/execution-resources/gpu-linux-resource-table.adoc[]
14021402

14031403
Example:
14041404

@@ -3415,7 +3415,7 @@ You can find usage examples on the xref:orchestration-cookbook#["Orchestration c
34153415
[#example-full-configuration]
34163416
== Example full configuration
34173417

3418-
include::../_includes/snippets/docker-auth.adoc[]
3418+
include::../_includes/partials/notes/docker-auth.adoc[]
34193419

34203420

34213421

0 commit comments

Comments
 (0)
0