Skip to content

Commit bb82547

Browse files
Merge branch 'main' into DOCSS-1857-remove-h5-6
2 parents 884f206 + 568e4df commit bb82547

File tree

15 files changed

+29
-34
lines changed

15 files changed

+29
-34
lines changed

.htmltest.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,8 @@ BaseURL: https://circleci.com/docs
66
IgnoreAltEmpty: true
77
IgnoreInternalEmptyHash: true
88
IgnoreURLs:
9-
- "[url]"
10-
- "[path]"
11-
- "/docs/"
12-
- "/docs/_/img/x-icon.svg"
9+
- "\\[url\\]" # Escaped literal [url] placeholder in search templates
10+
- "^/docs/" # All absolute paths from 404 page (navigation + assets)
1311
IgnoreDirs:
1412
- "api"
1513
OutputDir: ".htmltest"

docs/guides/modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@
269269
*** xref:integration:version-control-system-integration-overview.adoc[VCS integration overview]
270270
*** xref:integration:github-apps-integration.adoc[GitHub App integration]
271271
*** xref:integration:github-integration.adoc[GitHub OAuth app integration]
272-
*** xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth org]
272+
*** xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth org]
273273
*** xref:integration:gitlab-integration.adoc[GitLab integration]
274274
*** xref:integration:bitbucket-data-center-integration.adoc[Bitbucket data center integration]
275275
*** xref:integration:bitbucket-integration.adoc[Bitbucket Cloud integration]

docs/guides/modules/ROOT/partials/faq/pipelines-faq-snip.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ If your code is stored in GitHub you can split your configuration into multiple
55

66
include::ROOT:partial$tips/check-github-type-org.adoc[]
77

8-
If your organization is currently integrated with GitHub only through OAuth, an admin can take the one-time action of installing the CircleCI GitHub App to enable this functionality. For more information, see the xref:guides:integration:github-integration.adoc#installing-github-app-alongside-github-oauth-app[GitHub integration] page.
8+
If your organization is currently integrated with GitHub only through OAuth, an admin can take the one-time action of installing the CircleCI GitHub App to enable this functionality. For more information, see the xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
99

1010
While splitting configuration files is only available for GitHub App integrations, CircleCI does support dynamic configuration, which allows you to create configuration files based on specific pipeline values or paths, and continue one pipeline to another. See the xref:guides:orchestrate:dynamic-config.adoc[Dynamic configuration] page for more information.
1111

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,8 @@ To add or edit labels for a component, follow these steps:
198198

199199
. Select *Deploys* in the CircleCI web app sidebar.
200200
. You are now in the timeline view. Select the **Components** tab.
201-
. Select the cog icon image:guides:ROOT:icons/settings.svg[settings icon, role="no-border"] for your component. You can use the filter at the top of the page to help find the component you want.
202-
. 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.
201+
. Select the component by name. You can use the filter at the top of the page to help find the component you want.
202+
. You are now on the component view page. Select the edit button image:guides:ROOT:icons/edit-solid.svg[edit icon, role="no-border"] in the labels panel.
203203
. Enter or edit your label(s) and select btn:[Done].
204204

205205
==== Environment labels

docs/guides/modules/integration/pages/bitbucket-data-center-integration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ The ability to xref:orchestrate:scheduled-pipelines.adoc[schedule pipelines] is
217217
[#stop-building]
218218
=== Stop building
219219

220-
Bitbucket Data Center integrations do not currently support the **Stop Building** xref:security:stop-building-a-project-on-circleci.adoc#stop-building-a-project[option] that can normally be found in **Project settings**. As an alternative, you can xref:security:stop-building-a-project-on-circleci.adoc#remove-a-project-from-circleci[Delete a project].
220+
Bitbucket Data Center integrations do not currently support the **Stop Building** xref:security:stop-building-a-project-on-circleci.adoc#stop-building-a-project[option] that can normally be found in **Project settings**. As an alternative, you can xref:security:delete-organizations-and-projects.adoc#delete-a-project[Delete a project].
221221

222222
[#additional-ssh-keys-only]
223223
=== Additional SSH keys only

docs/guides/modules/integration/pages/github-apps-integration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
If your CircleCI organization is integrated with GitHub through the **CircleCI GitHub App**, the content on this page is for you.
77

88
****
9-
The **CircleCI GitHub App** is an add-on integration. All organizations that have `/github/` or `/circleci/` in the URL can install the GitHub App, including xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[those already integrated through the GitHub OAuth app].
9+
The **CircleCI GitHub App** is an add-on integration. All organizations that have `/github/` or `/circleci/` in the URL can install the GitHub App, including xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[those already integrated through the GitHub OAuth app].
1010
To check whether you organization has the CircleCI GitHub App installed, navigate to menu:Organization Settings[VCS Connections].
1111
****
1212

@@ -119,7 +119,7 @@ A subset of built-in environment variables are not available in GitHub-based pro
119119

120120
Before attempting to move your information from an org integrated with the GitHub OAuth app to an org integrated with CircleCI’s GitHub App, consider the following:
121121

122-
* If the motivation for moving is to **leverage new functionality that is only available to the GitHub App integration**, consider using your existing organization and installing the GitHub App alongside your OAuth app integration, as described in xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[this guide].
122+
* If the motivation for moving is to **leverage new functionality that is only available to the GitHub App integration**, consider using your existing organization and installing the GitHub App alongside your OAuth app integration, as described in xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[this guide].
123123
* If the motivation is to **completely remove the OAuth app integration** for security, compliance, or other reasons, follow the steps below.
124124

125125
[#Steps-to-migrate-to-an-organization-without-default-GitHub-OAuth-integration]

docs/guides/modules/integration/pages/github-integration.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ Key functionality enabled through the GitHub App integration includes the follow
346346
** **Cross-repo triggers**: Events in one repository can trigger builds on one or many other repositories.
347347
** **More GitHub events as triggers**: Pipelines can be set up to run on events other than "push", including pull request events, with more powerful customization of trigger conditions. For full details, see the xref:orchestrate:github-trigger-event-options.adoc[GitHub trigger event options] page.
348348

349-
More information is available on the xref:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
349+
More information is available on the xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
350350

351351
[#next-steps]
352352
== Next steps

docs/guides/modules/orchestrate/pages/github-trigger-event-options.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If your CircleCI organization is integrated with GitHub only through the **GitHu
2828
.Trigger options during project creation
2929
image::guides:ROOT:triggers/create-project-run-on.png[Create a project trigger and access trigger options]
3030

31-
If your CircleCI org is integrated via **GitHub OAuth** (see tip above), an org admin can install the CircleCI GitHub App to enable the full range of GitHub trigger events, as well as all other functionality enabled by the GitHub App. Installing the CircleCI GitHub App is a one-time action. For more information, see the xref:integration:github-integration.adoc#installing-github-app-alongside-github-oauth-app[GitHub OAuth integration overview].
31+
If your CircleCI org is integrated via **GitHub OAuth** (see tip above), an org admin can install the CircleCI GitHub App to enable the full range of GitHub trigger events, as well as all other functionality enabled by the GitHub App. Installing the CircleCI GitHub App is a one-time action. For more information, see the xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
3232

3333
== Supported trigger options
3434

docs/guides/modules/orchestrate/pages/orchestration-cookbook.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ image::guides:ROOT:triggers/run-on-open.png[Run on trigger options for GitHub Ap
2424

2525
=== Notes
2626

27-
* This option is only available for GitHub App pipelines. If you have a GitHub OAuth integration you can install the GitHub App into your GitHub org and then create GitHub App pipelines. This is a quick one-time action, as described in the xref:integration:github-integration.adoc#installing-github-app-alongside-github-oauth-app[GitHub integration] page.
27+
* This option is only available for GitHub App pipelines. If you have a GitHub OAuth integration you can install the GitHub App into your GitHub org and then create GitHub App pipelines. This is a quick one-time action, as described in the xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
2828
+
2929
include::ROOT:partial$tips/check-github-type-org.adoc[]
3030

@@ -46,7 +46,7 @@ image::guides:ROOT:triggers/run-on-open.png[Run on trigger options for GitHub Ap
4646

4747
=== Notes
4848

49-
* This option is only available for GitHub App pipelines. If you have a GitHub OAuth integration you can install the GitHub App into your GitHub org and then create GitHub App pipelines. This is a quick one-time action, as described in the xref:integration:github-integration.adoc#installing-github-app-alongside-github-oauth-app[GitHub integration] page.
49+
* This option is only available for GitHub App pipelines. If you have a GitHub OAuth integration you can install the GitHub App into your GitHub org and then create GitHub App pipelines. This is a quick one-time action, as described in the xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
5050
+
5151
include::ROOT:partial$tips/check-github-type-org.adoc[]
5252

@@ -73,7 +73,7 @@ workflows:
7373

7474
=== Notes
7575

76-
* The `pipeline.event.name` and `pipeline.event.action` variables are only available for GitHub App pipelines. If you have a GitHub OAuth integration you can install the GitHub App into your GitHub org and then create GitHub App pipelines. This is a quick one-time action, as described in the xref:integration:github-integration.adoc#installing-github-app-alongside-github-oauth-app[GitHub integration] page.
76+
* The `pipeline.event.name` and `pipeline.event.action` variables are only available for GitHub App pipelines. If you have a GitHub OAuth integration you can install the GitHub App into your GitHub org and then create GitHub App pipelines. This is a quick one-time action, as described in the xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
7777
+
7878
include::ROOT:partial$tips/check-github-type-org.adoc[]
7979

@@ -244,7 +244,7 @@ include::ROOT:example$logic-statement-examples/when-in-workflows/pr-synced-or-la
244244

245245
=== Notes
246246

247-
* The `pipeline.event.name` and `pipeline.event.action` variables are only available for GitHub App pipelines. If you have a GitHub OAuth integration you can install the GitHub App into your GitHub org and then create GitHub App pipelines. This is a quick one-time action, as described in the xref:integration:github-integration.adoc#installing-github-app-alongside-github-oauth-app[GitHub integration] page.
247+
* The `pipeline.event.name` and `pipeline.event.action` variables are only available for GitHub App pipelines. If you have a GitHub OAuth integration you can install the GitHub App into your GitHub org and then create GitHub App pipelines. This is a quick one-time action, as described in the xref:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
248248

249249
include::ROOT:partial$using-expressions/env-vars-in-conditional-caveat.adoc[]
250250

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ image::guides:ROOT:triggers/run-on-open.png[Trigger "Run on" menu open]
3030
3131
If you only use the **GitHub OAuth** integration, once a 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.
3232
33-
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].
33+
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:guides:integration:using-the-circleci-github-app-in-an-oauth-org.adoc[Using the CircleCI GitHub App in an OAuth organization] page.
3434
--
3535
GitLab::
3636
+

0 commit comments

Comments
 (0)