Skip to content

Commit 8caa686

Browse files
Convert from liquid to adoc syntax (#9255)
* remove liquid from 5 pages * convert pages to adoc syntax * fix image file path * fix typo
1 parent 34e2f82 commit 8caa686

39 files changed

+142
-260
lines changed

jekyll/_cci2/android-machine-image.adoc

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ contentTags:
66
---
77
= Android images with the machine executor
88
:page-layout: classic-docs
9-
:page-liquid:
109
:page-description: Using the Android image on the machine executor
1110
:icons: font
1211
:experimental:
@@ -36,7 +35,7 @@ Below you will find several examples demonstrating the use of the Android machin
3635

3736
The below sample uses the Android orb to run a single job.
3837

39-
{% include snippets/add-version-number.adoc %}
38+
include::../_includes/snippets/add-version-number.adoc[]
4039

4140
```yaml
4241
# .circleci/config.yaml
@@ -63,7 +62,7 @@ workflows:
6362

6463
This example shows how you can use more granular orb commands to achieve what the link:https://circleci.com/developer/orbs/orb/circleci/android#commands-start-emulator-and-run-tests[start-emulator-and-run-tests] command does.
6564

66-
{% include snippets/add-version-number.adoc %}
65+
include::../_includes/snippets/add-version-number.adoc[]
6766

6867
```yaml
6968
# .circleci/config.yml
@@ -110,8 +109,6 @@ workflows:
110109

111110
The following is an example of using the Android machine image, _without_ using the `circleci/android` link:https://circleci.com/developer/orbs/orb/circleci/android[orb]. These steps are similar to what is run when you use the link:https://circleci.com/developer/orbs/orb/circleci/android#jobs-run-ui-tests[`run-ui-tests` job] of the orb.
112111

113-
114-
{% raw %}
115112
```yaml
116113
# .circleci/config.yml
117114
version: 2.1
@@ -186,7 +183,6 @@ workflows:
186183
jobs:
187184
- build
188185
```
189-
{% endraw %}
190186

191187
[#using-the-android-image-on-server-v3x]
192188
=== Using the Android image on server
@@ -210,7 +206,7 @@ It is also possible to use the Android orb, as shown above, for cloud. Your serv
210206

211207
This example shows how you can use granular orb commands to achieve what the link:https://circleci.com/developer/orbs/orb/circleci/android#commands-start-emulator-and-run-tests[start-emulator-and-run-tests] command does.
212208

213-
{% include snippets/add-version-number.adoc %}
209+
include::../_includes/snippets/add-version-number.adoc[]
214210

215211
```yaml
216212
# .circleci/config.yml

jekyll/_cci2/artifacts.adoc

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ contentTags:
99
:experimental:
1010
:icons: font
1111
:page-layout: classic-docs
12-
:page-liquid:
1312

1413
This document describes how to work with artifacts on CircleCI. Use artifacts to persist data after a job or pipeline has completed. For example building documents or other assets, or saving test results for further inspection.
1514

@@ -20,15 +19,15 @@ Artifacts persist data after a job is completed and may be used for storage of t
2019

2120
For example, when a Java build/test process finishes, the output of the process is saved as a `.jar` file. CircleCI can store this file as an artifact, keeping it available after the process has finished.
2221

23-
image::{{site.baseurl}}/assets/img/docs/Diagram-v3-Artifact.png[Artifacts data flow]
22+
image::Diagram-v3-Artifact.png[Artifacts data flow]
2423

2524
Another example of an artifact is a project that is packaged as an Android app where the `.apk` file is uploaded to Google Play.
2625

2726
If a job produces persistent artifacts such as screenshots, coverage reports, core files, or deployment tarballs, CircleCI can automatically save and link them for you.
2827

29-
Navigate to a pipeline's *Job* page on the link:https://app.circleci.com/[CircleCI web app] to find the *Artifacts* tab. Artifacts are stored on Amazon S3 and are protected with your CircleCI account for private projects. There is a 3GB `curl` file size limit.
28+
Navigate to a pipeline's *Job* page on the link:https://app.circleci.com/[CircleCI web app] to find the *Artifacts* tab. Artifacts are stored on Amazon S3 and are protected with your CircleCI account for private projects. cURL file size is limited o 3GB.
3029

31-
image::{{site.baseurl}}/assets/img/docs/artifacts.png[Artifacts tab screenshot]
30+
image::artifacts.png[Artifacts tab screenshot]
3231

3332
By default, artifact storage duration is set to 30 days. This can be customized on the link:https://app.circleci.com/[CircleCI web app] by navigating to menu:Plan[Usage Controls]. Currently, 30 days is also the maximum storage duration you can set.
3433

@@ -43,7 +42,7 @@ If you need to restrict the connections allowed in your jobs, consider enabling
4342

4443
To upload artifacts created during builds, use the following example:
4544

46-
{% include snippets/docker-auth.adoc %}
45+
include::../_includes/snippets/docker-auth.adoc[]
4746

4847
[,yaml]
4948
----
@@ -70,7 +69,7 @@ jobs:
7069
path: /tmp/artifacts
7170
----
7271

73-
The `store_artifacts` step uploads two build artifacts: a file (`/tmp/artifact-1`) and a directory (`/tmp/artifacts`). After the artifacts successfully upload, view them in the *Artifacts* tab of the *Job* page in your browser. If you are uploading hundreds of artifacts, then consider link:https://support.circleci.com/hc/en-us/articles/360024275534?input_string=store_artifacts+step[compressing and uploading as a single compressed file] to accelerate this step. There is no limit on the number of `store_artifacts` steps a job can run.
72+
The `store_artifacts` step uploads two build artifacts: a file (`/tmp/artifact-1`) and a directory (`/tmp/artifacts`). After the artifacts successfully upload, view them in the *Artifacts* tab of the *Job* page in your browser. If you are uploading hundreds of artifacts, then consider link:https://support.circleci.com/hc/en-us/articles/360024275534?input_string=store_artifacts+step[compressing and uploading as a single compressed file] to accelerate this step. `store_artifacts` steps for a job are unlimited.
7473

7574
Currently, `store_artifacts` has two keys: `path` and `destination`.
7675

@@ -133,7 +132,7 @@ The `ulimit -c unlimited` removes the file size limit on core dump files. With t
133132

134133
Finally, the core dump files are stored to the artifacts service with `store_artifacts` in the `/tmp/core_dumps` directory.
135134

136-
image::{{ site.baseurl }}/assets/img/docs/core_dumps.png[Core dump file in Artifacts page]
135+
image::core_dumps.png[Core dump file in Artifacts page]
137136

138137
When CircleCI runs a job, a link to the core dump file appears in the *Artifacts* tab of the *Job* page.
139138

@@ -215,11 +214,11 @@ You can read more about using CircleCI's API to interact with artifacts in our l
215214
[#artifacts-and-self-hosted-runner]
216215
== Artifact storage customization
217216

218-
When using self-hosted runners, there is a network and storage usage limit included in your plan. There are certain actions related to artifacts that will accrue network and storage usage. Once your usage exceeds your limit, charges will apply.
217+
When using self-hosted runners, there is a network and storage usage limit included in your plan. Some actions related to artifacts that will accrue network and storage usage. Once your usage exceeds your limit, charges will apply.
219218

220219
Retaining an artifact for a long period of time will have storage cost implications, therefore, it is best to determine why you are retaining artifacts. One benefit of retaining an artifact might be so you can use it to troubleshoot why a build is failing. Once the build passes, the artifact is likely not needed. Setting a low storage retention for artifacts is recommended if this suits your needs.
221220

222-
You can customize storage usage retention periods for artifacts on the https://app.circleci.com/[CircleCI web app] by navigating to menu:Plan[Usage Controls]. For information on managing network and storage usage, see the link:{{site.baseurl}}/persist-data/#managing-network-and-storage-usage[Persisting Data] page.
221+
You can customize storage usage retention periods for artifacts on the https://app.circleci.com/[CircleCI web app] by navigating to menu:Plan[Usage Controls]. For information on managing network and storage usage, see the xref:persist-data#managing-network-and-storage-usage[Persisting Data] page.
223222

224223
[#artifacts-optimization]
225224
== Artifacts optimization

jekyll/_cci2/browser-testing.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ contentTags:
99
:experimental:
1010
:icons: font
1111
:page-layout: classic-docs
12-
:page-liquid:
1312

1413
This page describes common methods for running and debugging browser testing in your CircleCI config.
1514

@@ -41,7 +40,7 @@ WebDriver can operate in two modes, local, or remote:
4140

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

44-
{% include snippets/docker-auth.adoc %}
43+
include::../_includes/snippets/docker-auth.adoc[]
4544

4645
[,yaml]
4746
----

jekyll/_cci2/building-docker-images.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ contentTags:
99
:experimental:
1010
:icons: font
1111
:page-layout: classic-docs
12-
:page-liquid:
1312

1413
Use the remote Docker environment to build Docker images within the Docker execution environment.
1514

@@ -22,7 +21,7 @@ NOTE: The _remote_ in "remote Docker" is a legacy term from when remote Docker u
2221

2322
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:
2423

25-
{% include snippets/docker-auth.adoc %}
24+
include::../_includes/snippets/docker-auth.adoc[]
2625

2726
[,yaml]
2827
----
@@ -39,7 +38,7 @@ Using `setup_remote_docker` for a job means that all Docker commands execute loc
3938

4039
In the CircleCI web app, jobs that run in the remote Docker environment have the **Remote Docker** label, as follows:
4140

42-
image::{{ site.baseurl }}/assets/img/docs/remote-docker-label.png[Remote Docker label]
41+
image::remote-docker-label.png[Remote Docker label]
4342

4443
CAUTION: Only use `setup_remote_docker` key for jobs where your primary executor _is_ a Docker container. If your job uses a VM rather than a container (for example, your executor is `machine`) you do *not* need to use the `setup_remote_docker` key. For an example, see <<run-docker-commands-using-the-machine-executor,Run Docker commands using the `machine` executor>>.
4544

@@ -129,7 +128,7 @@ To optionally specify a Docker version, you can set it as a `version` attribute
129128
version: edge
130129
----
131130

132-
CircleCI supports the tags listed below for remote Docker, as per our link:{{site.baseurl}}/remote-docker-images-support-policy/#tagging[Remote Docker tagging policy].
131+
CircleCI supports the tags listed below for remote Docker, as per our xref:remote-docker-images-support-policy#tagging[Remote Docker tagging policy].
133132

134133
For *x86* and *Arm* architecture, the following tags are available:
135134

0 commit comments

Comments
 (0)