Skip to content

Commit f2d162b

Browse files
fix image blocks and xrefs (#9422)
1 parent 32d4c34 commit f2d162b

28 files changed

+56
-56
lines changed

jekyll/_cci2/about-circleci.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The CI/CD process allows developers to release higher quality, more stable produ
3232
[#circleci-in-your-workflow]
3333
== CircleCI in your workflow
3434

35-
A software repository on a supported version control system (VCS) needs to be authorized and added as a project on link:https://app.circleci.com/[CircleCI]. Every code change then triggers automated tests in a clean container or virtual machine. CircleCI runs each link:/docs/glossary/#job[job] in a separate xref:glossary#container[container] or link:https://circleci.com/developer/images?imageType=machine[virtual machine].
35+
A software repository on a supported version control system (VCS) needs to be authorized and added as a project on link:https://app.circleci.com/[CircleCI]. Every code change then triggers automated tests in a clean container or virtual machine. CircleCI runs each xref:glossary#job[job] in a separate xref:glossary#container[container] or link:https://circleci.com/developer/images?imageType=machine[virtual machine].
3636

3737
CircleCI sends an email notification of success or failure after the tests complete. CircleCI also includes integrated xref:notifications#[Slack and IRC notifications]. Code test coverage results are available from the details page for any project for which a reporting library is added.
3838

jekyll/_cci2/caching-strategy.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Using cache keys that are too strict can mean that you will get a minimal number
3636

3737
If your project has "flaky tests," workflows might be rerun unnecessarily. This will both use up your credits and increase your storage usage. To avoid this situation, address flaky tests. For help with identifying them, see xref:insights-tests#flaky-tests[Test Insights].
3838

39-
You can also consider configuring your projects to rerun failed jobs rather than entire workflows. To achieve this you can use the `when` step. For further information, see the link:/docs/configuration-reference/#the-when-attribute[Configuration Reference].
39+
You can also consider configuring your projects to rerun failed jobs rather than entire workflows. To achieve this you can use the `when` step. For further information, see the xref:configuration-reference#the-when-attribute[Configuration Reference].
4040

4141
[#split-cache-keys-by-directory]
4242
=== Split cache keys by directory

jekyll/_cci2/concepts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ A standalone project can have:
476476
Select *Projects* in the CircleCI web app sidebar to enter the projects dashboard. On the dashboard, you can set up and follow any project you have access to. There are two options:
477477

478478
* _Set Up_ or _Create_ any project that you are the owner of in your VCS.
479-
* _Follow_ any project in your organization to gain access to its pipelines and to subscribe to link:/docs/notifications/[email notifications] for the project's status.
479+
* _Follow_ any project in your organization to gain access to its pipelines and to subscribe to xref:notifications#[email notifications] for the project's status.
480480

481481
image::CircleCI-2.0-setup-project-circle101_cloud.png[Project dashboard]
482482

jekyll/_cci2/config-intro.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ image::config-intro-part1-job.png[Successful build job]
7777
+
7878
You should see your step - The First Step - with the output of the commands:
7979
+
80-
image:config-first-step.png[Successful step within job]
80+
image::config-first-step.png[Successful step within job]
8181

8282
NOTE: Although the `config.yml` syntax itself is straightforward, the indentation is more complicated. Incorrect indentation is the most common error. If you are experiencing problems with this example, check your indentation carefully, or copy and paste the sample code.
8383

jekyll/_cci2/config-policy-management-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The following how-to guides are available for config policies:
4040

4141
Config policies use a decision engine based on link:https://www.openpolicyagent.org/[Open Policy Agent (OPA)]. Policies are written in the Rego query language, as defined by OPA. Rule violations are surfaced when pipeline triggers are applied.
4242

43-
Policies can be developed locally and pushed to CircleCI using the CircleCI CLI. Policies can be saved to a repository within your VCS. For more information see the link:/docs/create-and-manage-config-policies[Create and manage config policies] page.
43+
Policies can be developed locally and pushed to CircleCI using the CircleCI CLI. Policies can be saved to a repository within your VCS. For more information see the xref:create-and-manage-config-policies#[Create and manage config policies] page.
4444

4545
CircleCI uses the result of OPA output to generate _decisions_ from policy executions. Those decisions have the following outputs:
4646

@@ -151,7 +151,7 @@ After declaring the `org` package and `policy_name` rule, policies can then be d
151151
* Enforcement status - Determines how a violation should be enforced.
152152
* Enablement - Determines if a policy violation should be enabled.
153153

154-
Using this format allows policy writers to create custom helper functions without impacting CircleCI's ability to parse policy evaluation output. You can create your own helper functions, but also CircleCI provides a set of helpers by importing `data.circleci.config` in your policies. For more information, see the link:/docs/config-policy-reference[Config policy reference].
154+
Using this format allows policy writers to create custom helper functions without impacting CircleCI's ability to parse policy evaluation output. You can create your own helper functions, but also CircleCI provides a set of helpers by importing `data.circleci.config` in your policies. For more information, see the xref:config-policy-reference#[Config policy reference].
155155

156156
NOTE: **Helpers** in the context of config policies are rules like any other, but rules that are not individually _enabled_ for the process of determining policy violation. Helpers can be written and used as building blocks for your policies.
157157

jekyll/_cci2/create-and-manage-config-policies.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ CircleCI policies are managed by pushing directories of policies to CircleCI via
6969

7070
* Store your policies in a repository in your VCS, within your organization. This is how policies are managed internally at CircleCI. Pushing a policy bundle is done by triggering a CircleCI pipeline.
7171

72-
* Create a bot account for pushing policies, and use its associated CircleCI personal API token for authentication. For maximum security the token should be stored as an environment variable within a context, and that context should be restricted to groups that are responsible for managing policies. For more information, see the link:/docs/contexts[Using Contexts] page.
72+
* Create a bot account for pushing policies, and use its associated CircleCI personal API token for authentication. For maximum security the token should be stored as an environment variable within a context, and that context should be restricted to groups that are responsible for managing policies. For more information, see the xref:contexts#[Using Contexts] page.
7373

7474
The rest on the steps in this section show how to set up a CI/CD pipeline to manage your policies.
7575

@@ -177,7 +177,7 @@ Once you have decided how to manage your policies, the next step is to create a
177177
[#write-your-policy]
178178
=== 1. Write your policy
179179

180-
CAUTION: Ensure you have authenticated your version of the CLI with a token, and updated the CLI, before attempting to use the CLI with config policies. See the link:/docs/local-cli[Installing the Local CLI] page for more information.
180+
CAUTION: Ensure you have authenticated your version of the CLI with a token, and updated the CLI, before attempting to use the CLI with config policies. See the xref:local-cli#[Installing the Local CLI] page for more information.
181181

182182
. <<config-policy-management-enablement,Enable config policies>> for your organization, if you have not already done so.
183183

jekyll/_cci2/creating-orbs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The included `config.yml` and `test-deploy.yml` files in the `./circleci` direct
4444
You can view the results of your tests directly on GitHub within the Pull Request, or, for a more detailed view, watch the entire pipeline in the CircleCI web app.
4545
Notice there are two workflows, `lint-pack` will run first and contains our linting, ShellCheck, review, and will publish a development version to be tested in the second workflow. The `test-deploy` workflow contains our integration tests, and can publish the production version of our orb when ready.
4646
+
47-
image:orbtools-11-checks.png[Orb test results as reported by GitHub Checks API on pull request]
47+
image::orbtools-11-checks.png[Orb test results as reported by GitHub Checks API on pull request]
4848
. *"Squash" Merge.*
4949
+
5050
When your changes are complete, we recommend (not required) link:https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-pull-request-commits[Squash Merging] your changes into a single commit, with a link:https://www.conventionalcommits.org/[Conventional Commit Message].

jekyll/_cci2/dynamic-config.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To enable dynamic configuration in CircleCI:
3636
. From the sidebar, select *Advanced*.
3737
. Scroll to the *Enable dynamic config using setup workflows* setting, and toggle it to the "on" position, as shown below:
3838
+
39-
image:dynamic-config-enable.png[Enable dynamic config in the UI]
39+
image::dynamic-config-enable.png[Enable dynamic config in the UI]
4040

4141
These steps make dynamic configuration features available for your project, but any _static_ `config.yml` you have previously set up will continue to work as normal.
4242

jekyll/_cci2/executor-intro.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ jobs:
6767
# Commands run in the primary container
6868
----
6969

70-
Find out more about the Docker execution environment on the link:/docs/using-docker/[Using Docker] page.
70+
Find out more about the Docker execution environment on the xref:using-docker#[Using Docker] page.
7171

7272
[#linux-vm]
7373
== Linux VM

jekyll/_cci2/glossary.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ A feature that enables building, running, and pushing images to Docker registrie
9696

9797
[#resource-class]
9898
== Resource class
99-
A configuration option for specifying compute resource sizing for a job. Also used as a label to identify a pool of self-hosted runners and to configure a job to run on a self-hosted runner from that pool. Read more on the link:/docs/resource-class-overview[resource class overview] page.
99+
A configuration option for specifying compute resource sizing for a job. Also used as a label to identify a pool of self-hosted runners and to configure a job to run on a self-hosted runner from that pool. Read more on the xref:resource-class-overview#[resource class overview] page.
100100

101101
[#step]
102102
== Step

0 commit comments

Comments
 (0)