Skip to content

Commit 1ab2642

Browse files
fix tab syntax (#154)
1 parent ea82015 commit 1ab2642

File tree

7 files changed

+82
-38
lines changed

7 files changed

+82
-38
lines changed

docs/guides/modules/config-policies/pages/config-policies-for-self-hosted-runner.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,10 @@ You can now push your new policy to your organization for it to take effect. You
8888
* Push the policy manually using the CLI from your local environment
8989
* Push your changes to your config policy repository if you are xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[managing policies via your VCS].
9090
91-
[tab.allow.manual]
91+
[tabs]
92+
====
93+
Manual::
94+
+
9295
--
9396
Create and upload the policy bundle using CircleCI CLI:
9497
@@ -106,13 +109,14 @@ If the upload was successful, you will see something like the following:
106109
}
107110
----
108111
--
109-
110-
[tab.allow.push_to_vcs]
112+
Push to VCS::
113+
+
111114
--
112115
If you have set up your config policies repository with the sample configuration shown in the xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[Create and manage config policies guide], push your changes to the `main` branch of your config policies repository, and head to the CircleCI web app to see your policy pipeline run.
113116
114117
You can also push to a development branch, in which case you will get a diff of your policy bundle when you push your changes, rather than your new policy being pushed to your CircleCI organization. This is useful when developing your policies.
115118
--
119+
====
116120

117121
NOTE: If you would like to write tests for your policy, check out the xref:test-config-policies.adoc[Test config policies] guide.
118122

docs/guides/modules/config-policies/pages/create-and-manage-config-policies.adoc

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,10 @@ You can now push your new policy to your organization for it to take effect. You
216216
* Push the policy manually using the CLI from your local environment
217217
* Push your changes to your config policy repository if you are managing policies via your VCS as shown <<manage-policies-with-your-vcs,above>>.
218218

219-
[tab.allow.manual]
219+
[tabs]
220+
====
221+
Manual::
222+
+
220223
--
221224
Create and upload the policy bundle using CircleCI CLI:
222225
@@ -234,13 +237,14 @@ If the upload was successful, you will see something like the following:
234237
}
235238
----
236239
--
237-
238-
[tab.allow.push_to_vcs]
240+
Push to VCS::
241+
+
239242
--
240243
If you have set up your config policies with the sample configuration shown <<manage-policies-with-your-vcs,above>>, push your changes to the `main` branch of your config policies repository, and head to the CircleCI web app to see your policy pipeline run.
241244
242245
You can also push to a development branch, in which case you will get a diff of your policy bundle when you push your changes, rather than your new policy being pushed to your CircleCI organization. This is useful when developing your policies.
243246
--
247+
====
244248

245249
Now, when a pipeline is triggered within your organization, the project's `.circleci/config.yml` will be validated against this policy.
246250

@@ -261,7 +265,10 @@ To illustrate making a change to an existing policy, suppose you made an error w
261265

262266
. Push the policy directory containing the updated policy:
263267
+
264-
[tab.change.manual]
268+
[tabs]
269+
====
270+
Manual::
271+
+
265272
--
266273
Create and upload the policy bundle using CircleCI CLI:
267274
@@ -279,13 +286,14 @@ If the upload was successful, you will see something like the following:
279286
}
280287
----
281288
--
289+
Push to vcs::
282290
+
283-
[tab.change.push_to_vcs]
284291
--
285292
Push your changes to the `main` branch of your config policies repository, and head to the CircleCI web app to see your policy pipeline run.
286293
287294
You can also push to a development branch, in which case you will get a diff of your policy bundle when you push your changes, rather than your new policy being pushed to your CircleCI organization. This is useful when developing your policies.
288295
--
296+
====
289297

290298
[#next-steps]
291299
== Next steps

docs/guides/modules/config-policies/pages/manage-contexts-with-config-policies.adoc

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,10 @@ You can now push your new policy to your organization for it to take effect. You
134134
* Push the policy manually using the CLI from your local environment
135135
* Push your changes to your config policy repository if you are managing policies via your VCS as shown in the xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[Manage policies with your VCS guide].
136136
137-
[tab.allow.manual]
137+
[tabs]
138+
====
139+
Manual::
140+
+
138141
--
139142
Create and upload the policy bundle using CircleCI CLI:
140143
@@ -152,13 +155,14 @@ If the upload was successful, you will see something like the following:
152155
}
153156
----
154157
--
155-
156-
[tab.allow.push_to_vcs]
158+
Push to VCS::
159+
+
157160
--
158161
If you have set up your config policies repository with the sample configuration shown in the xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[Manage policies with your VCS guide], push your changes to the `main` branch of your config policies repository, and head to the CircleCI web app to see your policy pipeline run.
159162
160163
You can also push to a development branch, in which case you will get a diff of your policy bundle when you push your changes, rather than your new policy being pushed to your CircleCI organization. This is useful when developing your policies.
161164
--
165+
====
162166

163167
NOTE: If you would like to write tests for your policy, check out the xref:test-config-policies.adoc[Test config policies] guide.
164168

@@ -294,7 +298,10 @@ You can now push your new policy to your organization for it to take effect. You
294298
* Push the policy manually using the CLI from your local environment, or;
295299
* Push your changes to your config policy repository if you are managing policies via your VCS as shown in the xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[Manage policies with your VCS guide].
296300
297-
[tab.block.manual]
301+
[tabs]
302+
====
303+
Manual::
304+
+
298305
--
299306
Create and upload the policy bundle using CircleCI CLI:
300307
@@ -312,13 +319,14 @@ If the upload was successful, you will see something like the following:
312319
}
313320
----
314321
--
315-
316-
[tab.block.push_to_vcs]
322+
Push to VCS::
323+
+
317324
--
318325
If you have set up your config policies repository with the sample configuration shown in the xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[Manage policies with your VCS guide], push your changes to the `main` branch of your config policies repository, and head to the CircleCI web app to see your policy pipeline run.
319326
320327
You can also push to a development branch, in which case you will get a diff of your policy bundle when you push your changes, rather than your new policy being pushed to your CircleCI organization. This is useful when developing your policies.
321328
--
329+
====
322330

323331
NOTE: If you would like to write tests for your policy, check out the xref:test-config-policies.adoc[Test config policies] guide.
324332

@@ -391,7 +399,10 @@ You can now push your new policy to your organization for it to take effect. You
391399
* Push the policy manually using the CLI from your local environment, or;
392400
* Push your changes to your config policy repository if you are managing policies via your VCS as shown in the xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[Manage policies with your VCS guide].
393401
394-
[tab.reserve.manual]
402+
[tabs]
403+
====
404+
Manual::
405+
+
395406
--
396407
Create and upload the policy bundle using CircleCI CLI:
397408
@@ -409,13 +420,14 @@ If the upload was successful, you will see something like the following:
409420
}
410421
----
411422
--
412-
413-
[tab.reserve.push_to_vcs]
423+
Push to VCS::
424+
+
414425
--
415426
If you have set up your config policies repository with the sample configuration shown in the xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[Manage policies with your VCS guide], push your changes to the `main` branch of your config policies repository, and head to the CircleCI web app to see your policy pipeline run.
416427
417428
You can also push to a development branch, in which case you will get a diff of your policy bundle when you push your changes, rather than your new policy being pushed to your CircleCI organization. This is useful when developing your policies.
418429
--
430+
====
419431

420432
NOTE: If you would like to write tests for your policy, check out the xref:test-config-policies.adoc[Test config policies] guide.
421433

@@ -495,7 +507,10 @@ You can now push your new policy to your organization for it to take effect. You
495507
* Push the policy manually using the CLI from your local environment, or;
496508
* Push your changes to your config policy repository if you are managing policies via your VCS as shown in the xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[Manage policies with your VCS guide].
497509
498-
[tab.branch.manual]
510+
[tabs]
511+
====
512+
Manual::
513+
+
499514
--
500515
Create and upload the policy bundle using CircleCI CLI:
501516
@@ -513,13 +528,14 @@ If the upload was successful, you will see something like the following:
513528
}
514529
----
515530
--
516-
517-
[tab.branch.push_to_vcs]
531+
Push to VCS::
532+
+
518533
--
519534
If you have set up your config policies repository with the sample configuration shown in the xref:create-and-manage-config-policies.adoc#manage-policies-with-your-vcs[Manage policies with your VCS guide], push your changes to the `main` branch of your config policies repository, and head to the CircleCI web app to see your policy pipeline run.
520535
521536
You can also push to a development branch, in which case you will get a diff of your policy bundle when you push your changes, rather than your new policy being pushed to your CircleCI organization. This is useful when developing your policies.
522537
--
538+
====
523539

524540
NOTE: If you would like to write tests for your policy, check out the xref:test-config-policies.adoc[Test config policies] guide.
525541

docs/guides/modules/insights/pages/insights.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,24 @@ CircleCI web application.
2424

2525
To access a specific project's Insights, view a pipeline's workflow and click the *Insights* button. Alternatively, you may access the Insights page by opening a pipeline's *Actions* menu while viewing the pipelines dashboard.
2626

27-
[tab.access-insights.Access_by_sidebar]
27+
[tabs]
28+
====
29+
Access_by_sidebar::
30+
+
2831
--
2932
image::guides:ROOT:screen_insights_access-3.png[Access insights from the CircleCI web app sidebar]
3033
--
31-
32-
[tab.access-insights.Access_by_workflow]
34+
Access_by_workflow::
35+
+
3336
--
3437
image::guides:ROOT:screen_insights_access-2.png[Access insights from a workflow in the CircleCI web app]
3538
--
36-
37-
[tab.access-insights.Access_by_pipeline]
39+
Access_by_pipeline::
40+
+
3841
--
3942
image::guides:ROOT:screen_insights_access-1.png[Access insights from a pipeline in the CircleCI web app]
4043
--
44+
====
4145

4246
[#workflow-overview]
4347
=== Workflow overview

docs/guides/modules/orchestrate/pages/triggers-overview.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ Pipelines are triggered in response to actions or scheduled to run at specific t
1010

1111
Trigger a pipeline on an event in your repository. The options available to you will be different depending on which integration you have set up, and for GitHub accounts, which GitHub authentication method you use. For steps to add a trigger for a project, see the xref:pipelines.adoc#add-a-trigger[Pipelines and triggers] page.
1212

13-
[tab.event-trigger.GitHub]
13+
[tabs]
14+
====
15+
GitHub::
16+
+
1417
--
1518
include::ROOT:partial$tips/check-github-type-org.adoc[]
1619
@@ -29,18 +32,19 @@ If you only use the **GitHub OAuth** integration, once a project is set up in Ci
2932
3033
TIP: If your org uses the **GitHub OAuth** integration, you can install the GitHub App into your org to set up GitHub App pipelines and access the trigger options described above. An org admin must take the one-time action of installing the CircleCI GitHub App to enable this functionality. For more information, see the xref:integration:github-integration.adoc#installing-github-app-alongside-github-oauth-app[GitHub OAuth integration overview].
3134
--
32-
33-
[tab.event-trigger.GitLab]
35+
GitLab::
36+
+
3437
--
3538
NOTE: The available GitLab trigger options are the same for GitLab Cloud and self-managed.
3639
3740
When you create a GitLab project in CircleCI you can set up multiple pipelines and triggers. The default trigger option is to build on every push to your repo. Select from a list or configure a combination of trigger options to control when each pipeline will trigger. You can choose from a selection of supported GitLab events. For a full list of options, see the xref:gitlab-trigger-options.adoc[GitLab trigger options] page.
3841
--
39-
40-
[tab.event-trigger.BitBucket_Cloud]
42+
BitBucket_Cloud::
43+
+
4144
--
4245
Once your Bitbucket Cloud project is set up in CircleCI, a pipeline is triggered each time a commit is pushed on a branch that has a `.circleci/config.yml` file included. One exception to this is if you use the "Only build pull requests" option. For more information on "Only build pull requests", see the xref:integration:oss.adoc[Build open source projects] page.
4346
--
47+
====
4448

4549
Once triggered, a running pipeline appears on the pipelines dashboard, which is accessible by selecting **Dashboard** from the left hand sidebar in the CircleCI web app.
4650

docs/guides/modules/orchestrate/pages/workflows.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -802,15 +802,19 @@ Workflows help to speed up your ability to respond to failures. One way to do th
802802
. Use the filters to find your project and pipeline.
803803
. Find the row in the pipeline view for the workflow you would like to rerun from failed and select the *Rerun from failed* icon. This option is also available in the workflow view using the rerun dropdown menu, which you can access by clicking on the workflow name or badge.
804804

805-
[tab.rerun-screenshot.Rerun_from_the_pipelines_page]
805+
[tabs]
806+
====
807+
Rerun_from_the_pipelines_page::
808+
+
806809
--
807810
image::guides:ROOT:orchestrate-and-trigger/rerun-from-failed-pipelines-page.png[Rerun a workflow from failed from the pipelines page]
808811
--
809-
810-
[tab.rerun-screenshot.Rerun_from_the_workflows_page]
812+
Rerun_from_the_workflows_page::
813+
+
811814
--
812815
image::guides:ROOT:orchestrate-and-trigger/rerun-from-failed-workflows-page.png[Rerun a workflow from failed from the workflows page]
813816
--
817+
====
814818

815819
NOTE: If you rerun a workflow containing a job that was previously re-run with SSH, the new workflow runs with SSH enabled for that job, even after SSH capability is disabled at the project level.
816820

docs/guides/modules/toolkit/pages/sample-config.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -440,11 +440,14 @@ NOTE: A job can only run when its dependencies are satisfied therefore it requir
440440
It is possible to use multiple xref:execution-managed:executor-intro.adoc[executor types]
441441
in the same workflow.
442442

443-
In `Example-1` each push will build and test the project on Linux, Windows and macOS.
443+
In Example 1 each push will build and test the project on Linux, Windows and macOS.
444444

445-
In `Example-2` each push of an iOS project will be built on macOS, and additional iOS tools (link:https://github.com/realm/SwiftLint[SwiftLint] and link:https://github.com/danger/danger[Danger]) will be run in Docker.
445+
In Example 2 each push of an iOS project will be built on macOS, and additional iOS tools (link:https://github.com/realm/SwiftLint[SwiftLint] and link:https://github.com/danger/danger[Danger]) will be run in Docker.
446446

447-
[tab.multiple-executors.Example_1]
447+
[tabs]
448+
====
449+
Example 1::
450+
+
448451
--
449452
[,yaml]
450453
----
@@ -709,8 +712,8 @@ workflows:
709712
only: main
710713
----
711714
--
712-
713-
[tab.multiple-executors.Example_2]
715+
Example 2::
716+
+
714717
--
715718
[,yaml]
716719
----
@@ -766,6 +769,7 @@ workflows:
766769
- build-and-test
767770
----
768771
--
772+
====
769773

770774
[#see-also]
771775
== See also

0 commit comments

Comments
 (0)