Skip to content

Commit 2b7bc2a

Browse files
committed
fix some internal links
1 parent 0e407da commit 2b7bc2a

File tree

10 files changed

+16
-16
lines changed

10 files changed

+16
-16
lines changed

docs/guides/modules/optimize/pages/artifacts.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ curl --silent --request GET --url https://circleci.com/api/v2/workflow/:workflow
181181
| wget --verbose --header "Circle-Token: $CIRCLE_TOKEN" --no-verbose --input-file -
182182
----
183183
184-
You can read more about using CircleCI's API to interact with artifacts in our link:../api/v1/index.html#artifacts[API reference guide].
184+
You can read more about using CircleCI's API to interact with artifacts in our link:../../api/v1/index.html#artifacts[API reference guide].
185185
186186
[cols="1,2", options="header"]
187187
|===

docs/guides/modules/optimize/pages/caching.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ During step execution, the templates above are replaced by runtime values and us
335335
| The number of seconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), also known as POSIX or UNIX epoch. This cache key is a good option if you need to ensure a new cache is always stored for each run.
336336
337337
| `{{ arch }}`
338-
| Captures OS and CPU (architecture, family, model) information. Useful when caching compiled binaries that depend on OS and CPU architecture, for example, `darwin-amd64-6_58` versus `linux-amd64-6_62`. See xref:server-admin:operator:faq.adoc#cpu-architecture-circleci-support[supported CPU architectures].
338+
| Captures OS and CPU (architecture, family, model) information. Useful when caching compiled binaries that depend on OS and CPU architecture, for example, `darwin-amd64-6_58` versus `linux-amd64-6_62`. See xref:reference:ROOT:faq.adoc#cpu-architecture-circleci-support[supported CPU architectures].
339339
|===
340340
341341
[#further-notes-on-using-keys-and-templates]
@@ -455,7 +455,7 @@ If your source code changes frequently, we recommend using fewer, more specific
455455
456456
Even with the narrowest `restore_cache` option (`source-v1-{{ .Branch }}-{{ .Revision }}`), source caching can be greatly beneficial, for example:
457457
458-
* Running repeated builds against the same git revision (for example, with link:../api/v1/index.html#trigger-a-new-build-by-project-preview[API-triggered builds])
458+
* Running repeated builds against the same git revision (for example, with link:../../api/v1/index.html#trigger-a-new-build-by-project-preview[API-triggered builds])
459459
* When using workflows, where you might otherwise need to `checkout` the same repository once per workflow job.
460460
461461
However, it is worth comparing build times with and without source caching. `git clone` is often faster than `restore_cache`.

docs/guides/modules/optimize/pages/persist-data.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,9 @@ Network charges apply when an organization has runner network egress beyond the
154154

155155
Storage charges apply when you retain artifacts, workspaces, and caches beyond the included storage GB allotment.
156156

157-
You can find out how much network and storage usage is available on your plan by visiting the features section of the link:https://circleci.com/pricing/[Pricing] page. If you would like more details about credit usage, and how to calculate your potential network and storage costs, visit the billing section on the xref:server-admin:operator:faq.adoc#calculate-monthly-storage-and-network-costs[FAQ] page.
157+
You can find out how much network and storage usage is available on your plan by visiting the features section of the link:https://circleci.com/pricing/[Pricing] page. If you would like more details about credit usage, and how to calculate your potential network and storage costs, visit the billing section on the xref:reference:ROOT:faq.adoc#calculate-monthly-storage-and-network-costs[FAQ] page.
158158

159-
For questions on data usage for the IP ranges feature, visit the xref:server-admin:operator:faq.adoc#calculate-monthly-IP-ranges-costs[FAQ] page.
159+
For questions on data usage for the IP ranges feature, visit the xref:reference:ROOT:faq.adoc#calculate-monthly-IP-ranges-costs[FAQ] page.
160160

161161
[#reducing-excess-use-of-network-egress-and-storage]
162162
=== Reducing excess use of network egress and storage

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -895,5 +895,5 @@ Go to menu:Settings[Branches] in GitHub and select btn:[Edit] on the protected b
895895
[#see-also]
896896
== See also
897897

898-
* See the xref:server-admin:operator:faq.adoc#workflows[workflows] section of the FAQ.
898+
* See the xref:reference:ROOT:faq.adoc#workflows[workflows] section of the FAQ.
899899
* For workflow configuration examples, see the link:https://github.com/CircleCI-Public/circleci-demo-workflows[CircleCI Demo Workflows] page on GitHub.

docs/guides/modules/plans-pricing/pages/plan-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Visit the pages below to learn about the features of CircleCI's plans.
3535
== Configuring your credit plan
3636
To set up a Free or Performance Plan, go to **Plan > Plan Overview** in the CircleCI link:https://app.circleci.com/[web application]. From there, select the plan that best fits your needs. To set up a Scale or Server Plan, link:https://circleci.com/talk-to-us/[contact us].
3737

38-
For details on cancelling a Performance Plan, refer to the xref:server-admin:operator:faq.adoc#cancel-performance-plan[Cancel Performance Plan FAQ].
38+
For details on cancelling a Performance Plan, refer to the xref:reference:ROOT:faq.adoc#cancel-performance-plan[Cancel Performance Plan FAQ].
3939

4040
[#managing-credit-usage]
4141
== Managing credit usage

docs/guides/modules/plans-pricing/pages/plan-performance.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The link:https://app.circleci.com/[CircleCI web app] allows for the customizatio
4646
=== Additional support options
4747
Additional support through SLAs (limited hours and days), and support package add-ons. The Performance Plan also has access to the link:https://discuss.circleci.com/[community forums], link:https://support.circleci.com/hc/en-us[support portal], and our link:https://support.circleci.com/hc/en-us/requests/new[global ticket-based system].
4848

49-
NOTE: For details on cancelling a Performance Plan, refer to the xref:server-admin:operator:faq.adoc#cancel-performance-plan[Cancel Performance Plan FAQ].
49+
NOTE: For details on cancelling a Performance Plan, refer to the xref:reference:ROOT:faq.adoc#cancel-performance-plan[Cancel Performance Plan FAQ].
5050

5151
[#circleci-features]
5252
== CircleCI features

docs/guides/modules/security/pages/inject-environment-variables-with-api.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ include::ROOT:partial$notes/server-api-examples.adoc[]
1111
Pipeline parameters can be used to pass variables using the CircleCI API v2.
1212

1313
A pipeline can be triggered with specific parameter values using the API v2
14-
endpoint to link:https://circleci.com/docs/api/v2/index.html#operation/getPipelineConfigById[trigger a pipeline].
14+
endpoint to link:../../api/v2/index.html#operation/getPipelineConfigById[trigger a pipeline].
1515
This can be done by passing a `parameters` key in the JSON packet of the `POST` body.
1616

1717
The example below triggers a pipeline with parameter values for `workingdir` and `image-tag`.
1818

1919
NOTE: In order to pass a parameter when triggering a pipeline via the API, the parameter must be xref:reference:ROOT:reusing-config.adoc#using-the-parameters-declaration[declared in the configuration file].
2020

21-
CAUTION: If your project code is integrated with CircleCI via the GitHub App, GitLab or Bitbucket Data Center, you will need to use the new link:https://circleci.com/docs/api/v2/index.html#tag/Pipeline/operation/triggerPipelineRun[Trigger a new pipeline endpoint] rather than the endpoint used in this example.
21+
CAUTION: If your project code is integrated with CircleCI via the GitHub App, GitLab or Bitbucket Data Center, you will need to use the new link:../../api/v2/index.html#tag/Pipeline/operation/triggerPipelineRun[Trigger a new pipeline endpoint] rather than the endpoint used in this example.
2222

2323
```shell
2424
curl -u ${CIRCLE_TOKEN}: -X POST --header "Content-Type: application/json" -d '{
@@ -71,7 +71,7 @@ export param1="value1"
7171
export param2="500"
7272
```
7373

74-
A POST API call with an empty body will start a new run of the named branch. Refer to the link:../api/v1/index.html#trigger-a-new-job-with-a-branch[Trigger a new job with a branch] section of the API v1 documentation for details.
74+
A POST API call with an empty body will start a new run of the named branch. Refer to the link:../../api/v1/index.html#trigger-a-new-job-with-a-branch[Trigger a new job with a branch] section of the API v1 documentation for details.
7575

7676
[#best-practices-for-using-build-parameters-with-api-v1]
7777
=== Best practices for using build parameters with API v1

docs/guides/modules/toolkit/pages/api-intro.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55

66
The CircleCI API may be used to make API calls to interact with your pipelines, projects and orgs, including retrieving detailed information about users, jobs, workflows, and pipelines, as well as triggering pipelines. There are currently two supported API versions:
77

8-
* link:../api/v1/index.html[API v1.1 Reference]
9-
* link:../api/v2/index.html[API v2 Reference]
8+
* link:../../api/v1/index.html[API v1.1 Reference]
9+
* link:../../api/v2/index.html[API v2 Reference]
1010
1111
API v2 includes several powerful features (for example, support for pipelines and pipeline parameters) that are unavailable in API v1.1. It is recommended that CircleCI users migrate their scripts to API v2 stable endpoints as soon as possible.
1212

@@ -19,7 +19,7 @@ To get started with the API v2, see the xref:api-developers-guide.adoc[API devel
1919

2020
The CircleCI API v2 release includes several new endpoints, and deprecates some others. The sections below list the endpoints added for this release, in addition to the endpoints that have been removed.
2121

22-
For a complete list of all API v2 endpoints, refer to the https://circleci.com/docs/api/v2/[API v2 Reference Guide], which contains a detailed description of each individual endpoint, as well as information on required and optional parameters, HTTP status and error codes, and code samples you may use in your workflows.
22+
For a complete list of all API v2 endpoints, refer to the link:../../api/v2/[API v2 Reference Guide], which contains a detailed description of each individual endpoint, as well as information on required and optional parameters, HTTP status and error codes, and code samples you may use in your workflows.
2323

2424
[#deprecated-endpoints]
2525
=== Deprecated endpoints

docs/guides/modules/toolkit/pages/examples-and-guides-overview.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ We have created demo applications in various languages so you can learn by examp
5252
[#platforms]
5353
== Platform guides
5454

55-
Use the tutorial associated with your platform to learn about the customization that is possible in a xref:reference:ROOT:configuration-reference[`.circleci/config.yml`].
55+
Use the tutorial associated with your platform to learn about the customization that is possible in a xref:reference:ROOT:configuration-reference.adoc[`.circleci/config.yml`].
5656

5757
[cols=2*, options="header"]
5858
|===

docs/reference/modules/ROOT/pages/configuration-reference.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1730,7 +1730,7 @@ During step execution, the templates above will be replaced by runtime values an
17301730
17311731
While choosing suitable templates for your cache `key`, keep in mind the following:
17321732
1733-
* Cache saving is not a free operation. See the billing section on the xref:server-admin:operator:faq.adoc#calculate-monthly-storage-and-network-costs[FAQ] page.
1733+
* Cache saving is not a free operation. See the billing section on the xref:reference:ROOT:faq.adoc#calculate-monthly-storage-and-network-costs[FAQ] page.
17341734
* It takes time to upload the cache.
17351735
* Best practice is to have a `key` that generates a new cache only if something actually changed and avoid generating a new one every time a job is run.
17361736
* Given the immutability of caches, it might be helpful to start all your cache keys with a version prefix `+v1-...+`. That way you will be able to regenerate all your caches just by incrementing the version in this prefix.

0 commit comments

Comments
 (0)