Skip to content

Commit 4433a8a

Browse files
remove the server component from main (#97)
* remove the server component from main * add back in links to latest server version from migration page * Fix tab syntax (#98) * update script to handle directories * update script * fix tab syntax * update link to server installation guides * fix typo
1 parent e42135c commit 4433a8a

File tree

92 files changed

+592
-8810
lines changed

Some content is hidden

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

92 files changed

+592
-8810
lines changed

antora-playbook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ content:
1414
start_path: docs/orbs
1515
- url: .
1616
start_path: docs/server-admin
17-
branches: [HEAD, server-v*]
17+
branches: [server-v*]
1818
- url: .
1919
start_path: docs/contributors
2020
ui:

docs/guides/modules/ROOT/partials/runner/terms.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
//[#self-hosted-runner-terms-agreement]
22
//== Self-hosted runner Terms Agreement
33

4-
[.tab.runner-terms.Web_app_installation]
4+
[tabs]
5+
====
6+
Web_app_installation::
7+
+
58
--
69
710
Before you can install self-hosted runners through the web app, you will need to agree to the https://circleci.com/legal/runner-terms/[CircleCI Runner Terms]. To be able to gain access to the *Self-Hosted Runners* section of the https://app.circleci.com/[CircleCI web app] or your CircleCI server app, an admin in your organization needs to navigate to menu:Organization Settings[Self-Hosted Runners], and agree to the terms.
@@ -26,7 +29,7 @@ For more information about the differences, see the link:https://docs.github.com
2629
****
2730
2831
--
29-
[.tab.runner-terms.CLI_installation]
32+
====
3033
--
3134

3235
If you are installing and using self-hosted runners through the CLI, you are agreeing to the https://circleci.com/legal/runner-terms/[CircleCI Runner Terms].

docs/guides/modules/about-circleci/pages/concepts.adoc

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,11 @@ An _image_ is a packaged system that includes instructions for creating a runnin
240240
241241
include::ROOT:partial$notes/docker-auth.adoc[]
242242
243-
[.tab.executors.Cloud]
243+
[tabs]
244+
====
245+
Cloud::
246+
+
247+
--
244248
[,yaml]
245249
----
246250
version: 2.1
@@ -284,8 +288,10 @@ workflows:
284288
- build2
285289
- build3
286290
----
287-
288-
[.tab.executors.Server]
291+
--
292+
Server::
293+
+
294+
--
289295
[,yaml]
290296
----
291297
version: 2.1
@@ -318,6 +324,8 @@ workflows:
318324
- build1
319325
- build2
320326
----
327+
--
328+
====
321329
322330
The primary container is defined by the first image listed in `.circleci/config.yml` file. This is where commands are executed. The Docker executor spins up a container with a Docker image. The machine executor spins up a complete Ubuntu virtual machine image. Further images can be added to spin up secondary/service containers.
323331

docs/guides/modules/about-circleci/pages/open-source.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66

77
This page provides the details of 3rd-party open source components used in CircleCI products.
88

9-
[.tab.oss-ack.Release_agent]
9+
[tabs]
10+
====
11+
Release_agent::
12+
+
1013
--
1114
The following 3rd-party open source components are used in the CircleCI release agent. The release agent is used to integrate CircleCI with Kubernetes clusters for release management. For more information, see the xref:deploy:deploys-overview.adoc[Deploys docs].
1215
@@ -16,8 +19,8 @@ The following 3rd-party open source components are used in the CircleCI release
1619
include::guides:ROOT:attachment$release-agent.csv[]
1720
|===
1821
--
19-
20-
[.tab.oss-ack.GOAT]
22+
GOAT::
23+
+
2124
--
2225
The following 3rd-party open source components are used in the CircleCI General Orchestration Agent (GOAT). GOAT is an agent used by self-hosted container runners for managing the container environment. For more information, see the xref:execution-runner:container-runner.adoc[Container Runner docs].
2326
@@ -27,8 +30,7 @@ The following 3rd-party open source components are used in the CircleCI General
2730
include::guides:ROOT:attachment$runner-init.csv[]
2831
|===
2932
--
30-
31-
[.tab.oss-ack.CircleCI_Runner]
33+
====
3234
--
3335
The following 3rd-party open source components are used in the CircleCI self-hosted runner. The CircleCI runner is a utility used to run CirlceCI jobs on self-hosted infrastructure. For more information, see the xref:execution-runner:runner-overview.adoc[self-hosted runner overview docs].
3436

docs/guides/modules/deploy/pages/deploy-android-applications.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,10 @@ You can set up your configuration with the link:https://circleci.com/developer/o
219219

220220
Using the Android orb gives you two options for deploying to the Google Play Store. You can either use the `deploy_to_play_store` job from the orb, or run each command individually in a job.
221221

222-
[.tab.configAndroidOrb.Use_the_deploy-to-play-store_job]
222+
[tabs]
223+
====
224+
Use_the_deploy-to-play-store_job::
225+
+
223226
--
224227
To deploy using the `deploy-to-play-store` job you just need to add an `android/deploy_to_play_store` job to your list of jobs in your workflow.
225228
@@ -254,8 +257,8 @@ workflows:
254257
255258
NOTE: The executor has no default value and must be set in the configuration.
256259
--
257-
258-
[.tab.configAndroidOrb.Run_each_command_individually]
260+
Run_each_command_individually::
261+
+
259262
--
260263
To run each command individually in a job, you will need to add the following commands to your job:
261264
@@ -296,6 +299,7 @@ jobs:
296299
lane_name: internal
297300
```
298301
--
302+
====
299303

300304
[#set-up-config-without-the-android-orb]
301305
=== b. Set up configuration without the Android orb

docs/guides/modules/deploy/pages/set-up-circleci-deploys.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,10 @@ include::ROOT:partial$deploy/supported-versions.adoc[]
3434

3535
== Set up CircleCI deploys
3636

37-
[.tab.environmentintegration.Kubernetes_cluster]
37+
[tabs]
38+
====
39+
Kubernetes_cluster::
40+
+
3841
--
3942
. In the CircleCI web app, select **Deploys** in the sidebar.
4043
. If this is your first environment setup, select btn:[Create your first Environment Integration]. If you already have environments set up, choose the **Environments** tab and select btn:[Create Environment Integration].
@@ -48,15 +51,16 @@ After completing all the setup steps in the app, you will have done the followin
4851
* Installed the release agent into your Kubernetes cluster
4952
* Configured your Kubernetes components.
5053
--
51-
52-
[.tab.environmentintegration.Amazon_SageMaker]
54+
Amazon_SageMaker::
55+
+
5356
--
5457
. In the CircleCI web app, select **Deploys** in the sidebar.
5558
. If this is your first environment setup, select btn:[Create your first Environment Integration]. If you already have environments set up, choose the **Environments** tab and select btn:[Create Environment Integration].
5659
. Enter a name for your environment, and a description if you would like.
5760
. Use the dropdown menu to choose your environment integration type, Amazon SageMaker, then select btn:[Save and Continue].
5861
. To get set up with CircleCI deploys and Amazon SageMaker from this point, follow the steps outlined on the xref:deploy-to-amazon-sagemaker.adoc[Deploy to Amazon SageMaker] page.
5962
--
63+
====
6064

6165
[#next-steps]
6266
== Next steps

docs/guides/modules/execution-managed/pages/executor-intro.adoc

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,10 @@ NOTE: *CircleCI cloud* The use of `machine: true` is deprecated. You must specif
6969

7070
To access the Linux VM execution environment, use the `machine` executor and specify a Linux image. For a full list of `machine` images, see the link:https://circleci.com/developer/images?imageType=machine[CircleCI Developer Hub]
7171

72-
[.tab.machine.Cloud]
72+
[tabs]
73+
====
74+
Cloud::
75+
+
7376
--
7477
[,yml]
7578
----
@@ -82,8 +85,8 @@ jobs:
8285
# Commands run in a Linux virtual machine environment
8386
----
8487
--
85-
86-
[.tab.machine.Server]
88+
Server::
89+
+
8790
--
8891
[,yml]
8992
----
@@ -94,6 +97,7 @@ jobs:
9497
# Commands run in a Linux virtual machine environment
9598
----
9699
--
100+
====
97101

98102
Find out more about the Linux VM execution environment in the xref:using-linuxvm.adoc[Using Linux Virtual Machines] page.
99103

@@ -128,7 +132,10 @@ To access the Windows execution environment, you can either:
128132

129133
For a full list of `machine` images, see the link:https://circleci.com/developer/images?imageType=machine[CircleCI Developer Hub].
130134

131-
[.tab.windowsblock.Cloud_with_orb]
135+
[tabs]
136+
====
137+
Cloud_with_orb::
138+
+
132139
--
133140
[,yml]
134141
----
@@ -147,8 +154,8 @@ jobs:
147154
- run: Write-Host 'Hello, Windows'
148155
----
149156
--
150-
151-
[.tab.windowsblock.Cloud]
157+
Cloud::
158+
+
152159
--
153160
[,yaml]
154161
----
@@ -166,8 +173,8 @@ jobs:
166173
- run: Write-Host 'Hello, Windows'
167174
----
168175
--
169-
170-
[.tab.windowsblock.Server]
176+
Server::
177+
+
171178
--
172179
[,yml]
173180
----
@@ -183,6 +190,7 @@ jobs:
183190
- run: Write-Host 'Hello, Windows'
184191
----
185192
--
193+
====
186194

187195
Find out more about the Windows execution environment in the xref:using-windows.adoc[Using the Windows Execution Environment] page. See link:https://circleci.com/developer/orbs/orb/circleci/windows[the Windows orb page in the developer hub] for the list of options available in the Windows orb.
188196

@@ -198,7 +206,10 @@ For a full list of `machine` images, see the link:https://circleci.com/developer
198206

199207
NOTE: It is not possible to run a GPU build on CircleCI server.
200208

201-
[.tab.gpublock.Linux]
209+
[tabs]
210+
====
211+
Linux::
212+
+
202213
--
203214
[,yml]
204215
----
@@ -213,8 +224,8 @@ jobs:
213224
- run: nvidia-smi
214225
----
215226
--
216-
217-
[.tab.gpublock.Windows_without_orb]
227+
Windows_without_orb::
228+
+
218229
--
219230
[,yml]
220231
----
@@ -229,8 +240,8 @@ jobs:
229240
- run: nvidia-smi
230241
----
231242
--
232-
233-
[.tab.gpublock.Windows_with_orb]
243+
Windows_with_orb::
244+
+
234245
--
235246
[,yml]
236247
----
@@ -246,6 +257,7 @@ jobs:
246257
- run: 'Write-Host ''Hello, Windows'''
247258
----
248259
--
260+
====
249261

250262
Find out more about the GPU execution environment on the xref:using-gpu.adoc[Using the GPU Execution Environment] page.
251263

@@ -254,7 +266,10 @@ Find out more about the GPU execution environment on the xref:using-gpu.adoc[Usi
254266

255267
To access the Arm VM execution environment, use the `machine` executor as detailed below, and specify either the `arm.medium` or the `arm.large` resource class. For a full list of `machine` images, see the link:https://circleci.com/developer/images?imageType=machine[CircleCI Developer Hub].
256268

257-
[.tab.armblock.Cloud]
269+
[tabs]
270+
====
271+
Cloud::
272+
+
258273
--
259274
[,yml]
260275
----
@@ -285,8 +300,8 @@ workflows:
285300
- build-large
286301
----
287302
--
288-
289-
[.tab.armblock.Server_on_AWS]
303+
Server_on_AWS::
304+
+
290305
--
291306
[,yml]
292307
----
@@ -317,6 +332,7 @@ workflows:
317332
- build-large
318333
----
319334
--
335+
====
320336

321337
Find out more about the Arm VM execution environment in the xref:using-arm.adoc[Using the Arm VM Execution Environment] page. You can also use xref:using-docker.adoc#arm[Arm on Docker].
322338

docs/guides/modules/execution-managed/pages/using-arm.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,10 @@
66

77
You can access the Arm VM (virtual machine) execution environment for a job by using the machine executor, specifying a Linux virtual machine image that includes Arm resources, and then specifying an Arm resource class.
88

9-
[.tab.armblock.Cloud]
9+
[tabs]
10+
====
11+
Cloud::
12+
+
1013
--
1114
[,yaml]
1215
----
@@ -21,8 +24,8 @@ jobs:
2124
- run: echo "Hello, Arm!"
2225
----
2326
--
24-
25-
[.tab.armblock.Server]
27+
Server::
28+
+
2629
--
2730
[,yaml]
2831
----
@@ -37,6 +40,7 @@ jobs:
3740
- run: echo "Hello, Arm!"
3841
----
3942
--
43+
====
4044

4145
[#available-resource-classes]
4246
== Available resource classes

docs/guides/modules/execution-managed/pages/using-gpu.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ jobs:
2525

2626
To use the Windows GPU execution environment, you can either choose to use the Windows orb and specify the built-in GPU executor, or use the machine executor and specify a Windows GPU-enabled image. Refer to the link:https://circleci.com/developer/orbs/orb/circleci/windows[Orb Registry page] for full details, and the link:https://circleci.com/developer/images?imageType=machine[Developer Hub] for full details of available machine executor images.
2727

28-
[.tab.gpublock.Windows_GPU_with_orb]
28+
[tabs]
29+
====
30+
Windows_GPU_with_orb::
31+
+
2932
--
3033
[,yaml]
3134
----
@@ -41,8 +44,8 @@ jobs:
4144
- run: '&"C:\Program Files\NVIDIA Corporation\NVSMI\nvidia-smi.exe"'
4245
----
4346
--
44-
45-
[.tab.gpublock.Windows_GPU_with_machine]
47+
Windows_GPU_with_machine::
48+
+
4649
--
4750
[,yaml]
4851
----
@@ -56,6 +59,7 @@ jobs:
5659
- run: '&"C:\Program Files\NVIDIA Corporation\NVSMI\nvidia-smi.exe"'
5760
----
5861
--
62+
====
5963

6064
[#available-resource-classes]
6165
== Available resource classes

docs/guides/modules/execution-managed/pages/using-linuxvm.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@ The use of `machine: true` is deprecated when using **CircleCI cloud**. You must
1919
* When using the machine executor on CircleCI server
2020
****
2121

22-
[.tab.machineblock.Cloud]
22+
[tabs]
23+
====
24+
Cloud::
25+
+
2326
--
2427
[,yaml]
2528
----
@@ -31,8 +34,8 @@ jobs:
3134
resource_class: large
3235
----
3336
--
34-
35-
[.tab.machineblock.Server]
37+
Server::
38+
+
3639
--
3740
[,yaml]
3841
----
@@ -43,6 +46,7 @@ jobs:
4346
resource_class: large
4447
----
4548
--
49+
====
4650

4751
You can view the list of available images xref:reference:ROOT:configuration-reference.adoc#available-linux-machine-images-cloud[in the Configuration Reference], or on the link:https://circleci.com/developer/images?imageType=machine[Developer Hub]. If you are working on an installation of CircleCI server, you will notice in the example above the syntax is slightly different, and the available Linux images are managed by your system administrator.
4852

0 commit comments

Comments
 (0)