Skip to content

Commit ce2176c

Browse files
committed
remove all uses of headings lower than h4
1 parent 258d349 commit ce2176c

File tree

24 files changed

+230
-187
lines changed

24 files changed

+230
-187
lines changed

docs/guides/modules/config-policies/pages/config-policy-management-overview.adoc

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,9 +155,6 @@ input.workflows # an array of nested structures mirroring workflows in the C
155155
input.jobs # an array of nested structures mirroring jobs in the CircleCI config
156156
----
157157

158-
[#define-a-rule]
159-
==== Define a rule
160-
161158
In OPA, rules can produce any type of output. At CircleCI, rules that produce violations must have outputs of the following types:
162159

163160
* String
@@ -168,7 +165,7 @@ This restriction is in place so that rule violations produce error messages that
168165
Helper rules that produce differently typed outputs can still be defined, but rules that will be considered when making CircleCI decisions must have the output types specified above. For more information see the <<#enablement>> section below.
169166

170167
[#evaluation]
171-
===== Evaluation
168+
==== Evaluation
172169

173170
Evaluation is how the decision engine determines if a config violates the given policy. The evaluation defines the name and ID of the rule, checks a condition, and returns a user-friendly string describing the violation. Rule evaluations include the **rule name** and an **optional rule ID**. The rule name will be used to enable and set the enforcement level for a rule.
174171

@@ -217,7 +214,7 @@ docker_images := {image | walk(input, [path, value]) # walk the entire config t
217214
----
218215

219216
[#enforcement]
220-
===== Enforcement
217+
==== Enforcement
221218

222219
The policy service allows rules to be enforced at different levels.
223220

@@ -239,7 +236,7 @@ hard_fail["use_official_docker_image"]
239236
----
240237

241238
[#enablement]
242-
===== Enablement
239+
==== Enablement
243240

244241
A rule must be enabled for it to be inspected for policy violations. Rules that are not enabled do not need to match CircleCI violation output formats, and can be used as helpers for other rules.
245242

docs/guides/modules/deploy/pages/deployment-overview.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,14 +187,12 @@ Labels are composed of two values separated by a colon, for example, `team:my-te
187187

188188
Once you have added labels to your components and environments, you can use them to filter your view in the deploys UI. In the timeline, environments, or components view, select a filter to reduce the content in the tab to only your selection. You can also use the label filter dropdown menu at the top of the page.
189189

190-
==== Add or edit labels
191-
192190
To add or edit labels follow the steps below.
193191

194192
.Add and Edit environment and component labels
195193
image::guides:ROOT:releases/edit-labels.png[Screenshot showing the location of the add/edit labels button]
196194

197-
===== Component labels
195+
==== Component labels
198196

199197
To add or edit labels for a component, follow these steps:
200198

@@ -204,7 +202,7 @@ To add or edit labels for a component, follow these steps:
204202
. You are now on the component settings page. Select the edit button image:guides:ROOT:icons/edit-solid.svg[edit icon, role="no-border"] in the labels panel.
205203
. Enter or edit your label(s) and select btn:[Done].
206204

207-
===== Environment labels
205+
==== Environment labels
208206

209207
To add or edit labels for an environment, follow these steps:
210208

docs/guides/modules/execution-runner/pages/container-runner.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Image match types govern how images are matched for container customization. The
198198

199199
* *Default:* The `Default` match type applies when an image did not match any of the other image match types. It sets a single specification for all such service containers.
200200

201-
===== Order of precedence
201+
==== Order of precedence
202202

203203
Selectors follow the hierarchy: `Exact` -> `Prefix` -> `Pattern` -> `Default`. If a given image name does not match any rule in the hierarchy, it defaults to the `Default` rule.
204204

@@ -237,7 +237,7 @@ agent:
237237
memory: "200Mi"
238238
----
239239

240-
===== Order of precedence
240+
==== Order of precedence
241241

242242
The `Resource class` scope overrides any `Global` scope selection for a given match type. If a match is available in both scopes, the `Resource class` scope prevails.
243243

docs/guides/modules/execution-runner/pages/runner-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Lists the available self-hosted runners based on the specified parameters. It is
6565
** This allows the endpoint to be accessible on circleci.com/api/v3/runner for users that have already logged into circleci.com
6666
6767
[#get-api-v3-runner-request]
68-
===== Request
68+
==== Request
6969

7070
[cols=5*, options="header"]
7171
|===

docs/guides/modules/execution-runner/pages/runner-upgrading-on-server.adoc

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -88,27 +88,42 @@ Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManage
8888

8989
The currently running `circleci-launch-agent` process will need to be halted before starting the newly updated binary. Platform-specific instructions for this are given below.
9090

91-
[#stopping-the-machine-runner-on-linux]
92-
===== Stopping the machine runner on Linux
93-
91+
[tabs]
92+
====
93+
Linux::
94+
+
95+
--
9496
Run the following commands:
9597
9698
```shell
9799
sudo systemctl stop circleci.service
98100
sudo systemctl disable circleci.service
99101
```
102+
--
103+
Mac::
104+
+
105+
--
106+
Run the following command:
100107
101-
[#stopping-the-machine-runner-on-mac]
102-
===== Stopping the machine runner on Mac
103-
104-
Run the following commands:
105108
106109
```shell
107110
sudo launchctl unload '/Library/LaunchDaemons/com.circleci.runner.plist'
108111
```
112+
--
113+
Windows::
114+
+
115+
--
116+
Run the following command:
117+
118+
119+
``` powershell
120+
Stop-ScheduledTask -TaskName "CircleCI Launch Agent"
121+
```
122+
--
123+
====
109124

110125
[#stopping-the-machine-runner-on-windows]
111-
===== Stopping the machine runner on Windows
126+
==== Stopping the machine runner on Windows
112127

113128
Run the following command:
114129

@@ -121,34 +136,38 @@ Stop-ScheduledTask -TaskName "CircleCI Launch Agent"
121136

122137
Platform-specific instructions are given below.
123138

124-
[#starting-on-linux]
125-
===== Starting on Linux
126-
139+
[tabs]
140+
====
141+
Linux::
142+
+
143+
--
127144
Run the following commands:
128145
129146
```shell
130147
sudo systemctl reload circleci.service
131148
sudo systemctl enable circleci.service
132149
sudo systemctl start circleci.service
133150
```
134-
135-
[#starting-on-mac]
136-
===== Starting on Mac
137-
151+
--
152+
Mac::
153+
+
154+
--
138155
Run the following command:
139156
140157
```shell
141158
sudo launchctl load '/Library/LaunchDaemons/com.circleci.runner.plist'
142159
```
143-
144-
[#starting-on-windows]
145-
===== Starting on Windows
146-
147-
Run the following commands:
160+
--
161+
Windows::
162+
+
163+
--
164+
Run the following command:
148165
149166
``` powershell
150167
Start-ScheduledTask -TaskName "CircleCI Launch Agent"
151168
```
169+
--
170+
====
152171

153172
[#additional-resources]
154173
=== Additional resources

docs/guides/modules/optimize/pages/use-the-circleci-cli-to-split-tests.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Two commands are available for you to split your tests. We recommend using `circ
6262
Alternatively, you can see `circleci tests split` examples <<tests-split-examples,here>>
6363

6464
[#tests-run-examples]
65-
==== Test framework examples using `circleci tests run`
65+
== Test framework examples using circleci tests run
6666

6767
The following set of examples show how to use the `circelci tests run` command to split and run your tests across parallel execution environments. Using this command also allows you to use the xref:test:rerun-failed-tests.adoc[rerun failed tests] feature.
6868

@@ -76,7 +76,7 @@ Some notes on the examples below:
7676
* If you do not use `store_test_results`, there will be no timing data available to split your tests.
7777

7878
[#ruby-rspec-tests]
79-
===== Ruby (RSpec)
79+
=== Ruby (RSpec)
8080

8181
. Add the following gem to your Gemfile:
8282
+
@@ -108,7 +108,7 @@ jobs:
108108
** Update the `glob` command to match your use case. See the RSpec section in the xref:test:collect-test-data.adoc#rspec[Collect Test Data] document for details on how to output test results in an acceptable format for `rspec`.
109109

110110
[#configure-a-job-running-ruby-cucumber-tests]
111-
===== Ruby (Cucumber)
111+
=== Ruby (Cucumber)
112112

113113
Modify your CircleCI configuration file to specify parallelism, and update your test command to use `circleci tests run`:
114114

@@ -133,7 +133,7 @@ jobs:
133133
* Update the `glob` command to match your use case. See the Cucumber section in the xref:test:collect-test-data.adoc#cucumber[Collect Test Data] document for details on how to output test results in an acceptable format for `Cucumber`.
134134

135135
[#cypress-tests]
136-
===== Cypress
136+
=== Cypress
137137

138138
. Use the link:https://www.npmjs.com/package/cypress-circleci-reporter[`cypress-circleci-reporter`] (this is a 3rd party tool that is not maintained by CircleCI). You can install the tool in your `.circleci/config.yml` or add to your `package.json`. Example for adding to `.circleci/config.yml`:
139139
+
@@ -178,7 +178,7 @@ jobs:
178178
** Cypress may output a warning: `Warning: It looks like you're passing --spec a space-separated list of arguments:`. This can be ignored, but it can be removed by following the guidance from our link:https://discuss.circleci.com/t/product-launch-re-run-failed-tests-only-circleci-tests-run/47775/18[community forum].
179179

180180
[#javascript-typescript-jest-tests]
181-
===== JavaScript/TypeScript (Jest)
181+
=== JavaScript/TypeScript (Jest)
182182

183183
. Install the `jest-junit` dependency. You can add this step in your `.circleci/config.yml`:
184184
+
@@ -217,7 +217,7 @@ jobs:
217217
** `JEST_JUNIT_ADD_FILE_ATTRIBUTE=true` is added to ensure that the `file` attribute is present. `JEST_JUNIT_ADD_FILE_ATTRIBUTE=true` can also be added to your `jest.config.js` file instead of including it in `.circleci/config.yml`, by using the following attribute: `addFileAttribute="true"`.
218218

219219
[#playwright-tests]
220-
===== Playwright
220+
=== Playwright
221221

222222
Modify your CircleCI configuration file to specify parallelism, and update your test command to use `circleci tests run`:
223223

@@ -246,7 +246,7 @@ jobs:
246246
* Ensure that you are using version 1.34.2 or later of Playwright. Earlier versions of Playwright may not output JUnit XML in a format that is compatible with this feature.
247247

248248
[#kotlin-or-gradle-tests]
249-
===== Kotlin or Gradle
249+
=== Kotlin or Gradle
250250

251251
. Modify your CircleCI configuration file to specify parallelism, and update your test command to use `circleci tests run`:
252252
+
@@ -280,7 +280,7 @@ jobs:
280280
. Update the `glob` command to match your use case.
281281

282282
[#configure-a-job-running-go-tests]
283-
===== Go
283+
=== Go
284284

285285
Modify your CircleCI configuration file to specify parallelism, and update your test command to use `circleci tests run`:
286286

@@ -302,7 +302,7 @@ jobs:
302302
* Ensure you are using `xargs` in your `circleci tests run` command to pass the list of test files/classnames via stdin to `--command`.
303303

304304
[#elixir-tests]
305-
===== Elixir
305+
=== Elixir
306306

307307
Modify your CircleCI configuration file to specify parallelism, and update your test command to use `circleci tests run`:
308308

@@ -332,7 +332,7 @@ jobs:
332332
* Update the `glob` command to match your use case.
333333

334334
[#configure-a-job-running-phpunit-tests]
335-
===== PHPUnit
335+
=== PHPUnit
336336

337337
Modify your CircleCI configuration file to specify parallelism, and update your test command to use `circleci tests run`:
338338

@@ -362,7 +362,7 @@ jobs:
362362
* Note that this example uses a utility named link:https://github.com/previousnext/phpunit-finder[`phpunit-finder`] which is a third party tool that is not supported by CircleCI, use at your own risk.
363363

364364
[#configure-django-tests]
365-
===== Django
365+
=== Django
366366

367367
Modify your CircleCI configuration file to specify parallelism, and update your test command to use `circleci tests run`. Also, Django takes as input test filenames with a format that uses dots ("."), however, it outputs JUnit XML in a format that uses slashes "/". To account for this, get the list of test filenames first, change the filenames to be separated by dots "." instead of slashes "/", and pass the filenames into the test command.
368368

@@ -393,7 +393,7 @@ jobs:
393393
. Ensure you are using `xargs` in your `circleci tests run` command to pass the list of test files/classnames via stdin to `--command`.
394394

395395
[#output-test-files-only]
396-
===== Output test files only
396+
=== Output test files only
397397

398398
If your testing set-up on CircleCI is not compatible with invoking your test runner in the `circleci tests run` command, you can opt to use `circleci tests run` to:
399399

@@ -520,7 +520,7 @@ The available timing data will then be analyzed and your tests will be split acr
520520
NOTE: If no timing data is found, you will receive a message: `Error auto-detecting timing type, falling back to weighting by name.`. The tests will then be split alphabetically by test name.
521521

522522
[#set-the-timing-type]
523-
===== Set the timing type
523+
=== Set the timing type
524524

525525
The environment CLI attempts to autodetect the granularity of the test split (for example, whether to split by filename, or down to class name) based on the input. You may need to choose a different timing type depending on how your test coverage output is formatted, using the `--timings-type` option. Valid timing types are:
526526

@@ -534,7 +534,7 @@ cat my_java_test_classnames | circleci tests split --split-by=timings --timings-
534534
```
535535

536536
[#set-the-default-value-for-missing-timing-data]
537-
===== Set the default value for missing timing data
537+
=== Set the default value for missing timing data
538538

539539
For partially found test results, any tests with missing data are assigned a random small value. You can override this default value with the `--time-default` flag:
540540

@@ -543,7 +543,7 @@ circleci tests glob "**/*.rb" | circleci tests split --split-by=timings --time-d
543543
```
544544

545545
[#download-timing-data]
546-
===== Download timing data
546+
=== Download timing data
547547

548548
If you need to manually store and retrieve timing data, add the xref:reference:ROOT:configuration-reference.adoc#storeartifacts[`store_artifacts` step] to your job.
549549

docs/guides/modules/permissions-authentication/pages/openid-connect-tokens.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ workflows:
216216
You can take advantage of the format of the claims in CircleCI's <<format-of-the-openid-connect-id-token,OIDC token>> to limit what your CircleCI jobs can do in AWS.
217217

218218
[#limit-role-access-based-on-project]
219-
===== Limit role access based on project
219+
=== Limit role access based on project
220220

221221
If certain projects should only be able to access certain AWS resources, you can restrict your IAM role so that only CircleCI jobs in a specific project can assume that role.
222222

@@ -235,7 +235,7 @@ To do this, edit your IAM role's trust policy so that only an OIDC token from yo
235235
This uses https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String[StringLike] to match the sub claim of CircleCI's OIDC token in your chosen project. Now, jobs in your other projects cannot assume this role.
236236

237237
[#limit-role-access-based-on-branch]
238-
===== Limit role access based on branch
238+
=== Limit role access based on branch
239239

240240
You can also restrict access to specific branches. The following is an example of a trust policy that restricts the `AssumeRoleWithWebIdentity` action to any project pipelines running only on the `main` branch in the `my-org` GitHub organization and the CircleCI organization with the ID: `organization_id`. Note that the `sub` claim uses the `$CIRCLE_OIDC_TOKEN_V2` format.
241241

docs/guides/modules/toolkit/pages/environment-cli-usage-guide.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ For more information, including an example, see the xref:permissions-authenticat
109109

110110
A subcommand of `run`. The `circleci run release` commands allow you to manage your deployments.
111111

112-
===== Plan
112+
==== Plan
113113

114114
A subcommand of `release`. The `circleci run release plan` command is used to plan and identify a new deployment that will be referenced in the CircleCI UI. When a release is planned you can then update its status later in your pipeline to track progress of a deployment.
115115

@@ -154,7 +154,7 @@ jobs:
154154

155155
For more information on using the `circleci run release plan` command, see the xref:deploy:configure-deploy-markers.adoc[Configure deploy markers] page.
156156

157-
===== Update
157+
==== Update
158158

159159
A subcommand of `release`. Use the `circleci run release update` command to update the status of the deployment.
160160

@@ -185,7 +185,7 @@ jobs:
185185

186186
For more information on using the `circleci run release update` command, see the xref:deploy:configure-deploy-markers.adoc[Configure deploy markers] page.
187187

188-
===== Log
188+
==== Log
189189

190190
A subcommand of `release`. The `circleci run release log` command allows you to log your deployments without status updates
191191

0 commit comments

Comments
 (0)