Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions archive/bitbucket-data-center-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ Integrate with CircleCI to access features for automated software delivery:
=== Integrate a project with CircleCI

. **Set up your integration with Bitbucket Data Center if you have not already**:
.. In the CircleCI web app, select **Organization Settings** in the sidebar.
.. In the CircleCI web app, select **Org** in the sidebar.
.. Select **Integrations** in the sidebar.
.. Select btn:[Set Up Integration] next to Bitbucket Data Center.
.. In the modal, enter your Bitbucket Data Center instance URL and your known_hosts. For guidance on generating known_hosts, see <<known-hosts>>.
+
NOTE: If you are using both CircleCI's Bitbucket Data Center and GitLab self-managed integrations, there is a known bug in the menu:Organization Settings[Integrations] section of the CircleCI web app. Adding a `known_hosts` to one integration will populate the `known_hosts` for the other integration. To use both Bitbucket Data Center and GitLab self-managed integrations within the same CircleCI organization, add both respective `known_hosts` values to the one input field separated by a new line.
NOTE: If you are using both CircleCI's Bitbucket Data Center and GitLab self-managed integrations, there is a known bug in the menu:Org[Integrations] section of the CircleCI web app. Adding a `known_hosts` to one integration will populate the `known_hosts` for the other integration. To use both Bitbucket Data Center and GitLab self-managed integrations within the same CircleCI organization, add both respective `known_hosts` values to the one input field separated by a new line.

.. Select btn:[Set Up Integration].
.. Select the back arrow to exit **Organization Settings**.
.. Select the back arrow to exit **Org**.

. For the next sections you will need to **create a project HTTP access token** with the project admin scope. Create this under Projects in Bitbucket. For more information, see the link:https://confluence.atlassian.com/bitbucketserver/http-access-tokens-939515499.html[Bitbucket docs]. Copy the token somewhere safe, you will need to enter it when creating pipelines and triggers in CircleCI.

Expand Down Expand Up @@ -109,7 +109,7 @@ The output will look something like the following:
[bitbucket-datacenter.example.com]:1234 ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAA//NF6iU86j0hfGxn8ncjgwvmk9tMKzhFqrRLaltP0TGt760PhfWk070raKLHS3L6H0BdN9qNVsTk63czziFDmtBehE82/XXX+59MuppY0DHG3brNvw4REPmzZkQNIR6Cs8b15iFbwnIL51IH9kBVMztWQaRDPkPPxihM6e0n/vo5n3uEIPCTZiwLgKRcpeks2LsfbsW0NN5Q7J1Irp/ACstfrsFWSntranbjMe6cIwELNY6FhvYmETzH0cY0=
----

Copy the full output from the `ssh-keyscan` command and enter it into the "known hosts" text box when setting up your integration in the CircleCI web app under menu:Organization Settings[Integrations].
Copy the full output from the `ssh-keyscan` command and enter it into the "known hosts" text box when setting up your integration in the CircleCI web app under menu:Org[Integrations].

== How it works

Expand Down Expand Up @@ -175,7 +175,7 @@ For details see the xref:add-ssh-key.adoc[Additional SSH keys overview].

For Bitbucket Data Center integrations, organizations and users are managed independently from your VCS. Organizations and users are considered CircleCI organizations and users, with their own roles and permissions that do not rely on those defined in your VCS.

To manage settings at the organization level, select btn:[Organization Settings] in the CircleCI web app sidebar.
To manage settings at the organization level, select btn:[Org] in the CircleCI web app sidebar.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To manage settings at the organization level, select btn:[Org] in the CircleCI web app sidebar.
To manage settings at the organization level, select *Org* in the CircleCI web app sidebar.


[#organization-settings-people]
=== People
Expand All @@ -185,7 +185,7 @@ Add or remove users, and manage user roles for the organization as well as user
[#organization-settings-integrations]
=== Integrations

The Integrations page under Organization Settings allows you to connect your organization with either Bitbucket Data Center or a GitLab self-managed instance. Steps to integrate with Bitbucket Data Center are described on the xref:getting-started:create-project.adoc[Create a project] page.
The Integrations page under Org allows you to connect your organization with either Bitbucket Data Center or a GitLab self-managed instance. Steps to integrate with Bitbucket Data Center are described on the xref:getting-started:create-project.adoc[Create a project] page.

[#deprecated-system-environment-variables]
== Deprecated system environment variables
Expand Down
4 changes: 2 additions & 2 deletions archive/github-apps-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If your CircleCI organization is integrated with GitHub through the **CircleCI G

****
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].
To check whether you organization has the CircleCI GitHub App installed, navigate to menu:Organization Settings[VCS Connections].
To check whether you organization has the CircleCI GitHub App installed, navigate to menu:Org[VCS Connections].
****

This page walks you through integrating a GitHub project with CircleCI through the CircleCI GitHub App integration. The sections below introduce you to concepts and ways to manage CI/CD (continuous integration and continuous delivery) pipelines for your GitHub project. CircleCI features that are in development for GitHub App projects are detailed in the <<currently-not-supported>> section.
Expand Down Expand Up @@ -96,7 +96,7 @@ image::guides:ROOT:triggers/run-on-open.png[Run on trigger menu options]

For GitHub App integrations, organizations and users are managed independently from your VCS. Organizations and users are considered CircleCI organizations and users, with their own roles and permissions that do not rely on those defined in your VCS.

To manage settings at the organization level, select btn:[Organization Settings] in the CircleCI web app sidebar.
To manage settings at the organization level, select btn:[Org] in the CircleCI web app sidebar.

[#organization-settings-people]
=== People
Expand Down
2 changes: 1 addition & 1 deletion archive/github-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ NOTE: CircleCI only asks for permissions that are absolutely necessary. However,

Enabling SAML protection on a GitHub org can cause changes to CircleCI’s settings related to GitHub Checks and GitHub status updates. Ensure these settings are configured for their desired state after enabling SAML for your organization. You can find these settings at:

* GitHub Checks, from the GitHub website, select menu:Organization Settings[VCS > GitHub Checks]
* GitHub Checks, from the GitHub website, select menu:Org[VCS > GitHub Checks]
* GitHub status updates, from the CircleCI web app menu:Project Settings[Advanced > GitHub Status Updates]

For more information on GitHub Checks and GitHub status updates, see the xref:enable-checks.adoc#github-check-and-github-status-updates[Enabling GitHub Checks].
Expand Down
6 changes: 3 additions & 3 deletions archive/gitlab-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ image::guides:ROOT:gl-sm-create-project.png[Create a new project in a self-manag
. Copy and paste the SSH host key from your self-managed instance into **known_hosts**. Select **Connect**.
+
NOTE: If you are using both CircleCI's Bitbucket Data Center and GitLab self-managed integrations, there is a known bug in the menu:Organization Settings[Integrations] section of the CircleCI web app. Adding a `known_hosts` to one integration will populate the `known_hosts` for the other integration. To use both Bitbucket Data Center and GitLab self-managed integrations within the same CircleCI organization, add both respective `known_hosts` values to the one input field separated by a new line.
NOTE: If you are using both CircleCI's Bitbucket Data Center and GitLab self-managed integrations, there is a known bug in the menu:Org[Integrations] section of the CircleCI web app. Adding a `known_hosts` to one integration will populate the `known_hosts` for the other integration. To use both Bitbucket Data Center and GitLab self-managed integrations within the same CircleCI organization, add both respective `known_hosts` values to the one input field separated by a new line.
. Once your account is successfully authorized, select the repository for your CircleCI project, and enter a project name.
Expand Down Expand Up @@ -216,7 +216,7 @@ For more information on SSH keys, refer to the xref:add-ssh-key.adoc[Adding an S

For GitLab integrations, organizations and users are managed independently from your VCS. Organizations and users are considered CircleCI organizations and users, with their own roles and permissions that do not rely on those defined in your VCS.

To manage settings at the organization level, select btn:[Organization Settings] in the CircleCI web app sidebar.
To manage settings at the organization level, select btn:[Org] in the CircleCI web app sidebar.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To manage settings at the organization level, select btn:[Org] in the CircleCI web app sidebar.
To manage settings at the organization level, select *Org* in the CircleCI web app sidebar.


[#organization-settings-people]
=== People
Expand All @@ -228,7 +228,7 @@ Add or remove users, and manage user roles for the organization as well as user

For GitLab self-managed organizations, you may connect additional self-managed instances to be integrated with your organization.

. Navigate to **Integrations** within **Organization Settings** to add a new instance.
. Navigate to **Integrations** within **Org** to add a new instance.
+
image::guides:ROOT:gl-sm-integrations.png[Add a new self-managed instance on the Integrations page]

Expand Down
2 changes: 1 addition & 1 deletion claude.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Replace problematic terms with inclusive alternatives:

### Text Styling
- **Use bold** for GUI menu options and button text:
- Select **Organization Settings** from the sidebar
- Select **Org** from the sidebar
- Click **Set Up Project**
- **Use italics** for commonly understood technical concepts (not CircleCI features):
- _Continuous Integration_
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ pass:[<!-- vale off -->]
== Styling text

* Use **bold** for GUI menu options and button text. For example:
** Select **Organization Settings** from the sidebar
** Select **Org** from the sidebar
** Select **VCS** in the **Project Settings** window
** Select **Projects** from the sidebar and click **Set Up Project** for the project you want to follow

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
. In the link:https://app.circleci.com/home[CircleCI web app], select **Organization Home** in the sidebar.
. In the link:https://app.circleci.com/home[CircleCI web app], select **Home** in the sidebar.
. Select btn:[Create Project] at the top of the page, or anywhere in the btn:[Create a project] card if this is your first project.
+
.Create a project button
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ For GitHub users, your account has the "Owner" role in your GitHub organization.

For Bitbucket Cloud users, your account has "Admin" permissions in your Bitbucket repository.

For GitLab users, your account is listed as "Org Admin" in the CircleCI web app under menu:Organization Settings[People].
For GitLab users, your account is listed as "Org Admin" in the CircleCI web app under menu:Org[People].

[#what-happens-upon-cancelling-a-performance-plan-subscription]
=== What happens upon cancelling a Performance Plan subscription?
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/modules/ROOT/partials/orbs/orb-types.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If you would like to author your own registry orb, read more on the xref:orbs:au

*URL orbs*:: URL orbs are stored in a publicly accessible location (for example, a git repository or a public S3 object) and are not published to the orbs registry.
+
URL orbs do not follow semantic versioning, and can be accessed directly using an `https` URL. An org-level allow list is used to manage the addresses of URL orbs that can be used in a project in that organization. Organization admins can manage the allow list at menu:Organization Settings[Orbs].
URL orbs do not follow semantic versioning, and can be accessed directly using an `https` URL. An org-level allow list is used to manage the addresses of URL orbs that can be used in a project in that organization. Organization admins can manage the allow list at menu:Org[Orbs].
+
See the xref:orbs:use:managing-url-orbs-allow-lists.adoc[Managing URL Orb Allow Lists] guide for more information on scoping allowed URL orbs for your organization.
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In order to install self-hosted runners, you will need to create a namespace and

NOTE: To create resource classes and tokens you need to be an organization administrator in the VCS provider.

You can view your installed runners on the inventory page in the https://app.circleci.com/[web app] or your CircleCI server app, by clicking *Self-Hosted Runners* on the left navigation.
You can view your installed runners on the inventory page in the https://app.circleci.com/[web app] or your CircleCI server app, by clicking *Runners* on the left navigation.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can view your installed runners on the inventory page in the https://app.circleci.com/[web app] or your CircleCI server app, by clicking *Runners* on the left navigation.
You can view your installed runners on the inventory page in the link:https://app.circleci.com/[web app] or your CircleCI server app, by selecting *Runners* from the sidebar.


. Create a namespace for your organization's self-hosted runners. *Each organization can only create a single namespace*. We suggest using a lowercase representation of your CircleCI organization's account name. If you already use orbs, this namespace should be the same namespace orbs use.
+
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
//== CircleCI web app installation: pre-steps
In order to install self-hosted runners, you will need to create a namespace and resource class token. To create resource classes and tokens, you need to be an organization admin in the VCS provider. You can read about namespaces and resource classes on the <<runner-concepts#namespaces-and-resource-classes,Concepts>> page.

You can view your installed runners on the inventory page, by clicking *Self-Hosted Runners* on the left navigation.
You can view your installed runners on the inventory page, by clicking *Runners* on the left navigation.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can view your installed runners on the inventory page, by clicking *Runners* on the left navigation.
You can view your installed runners on the inventory page, by selecting *Runners* from the sidebar.


. On the https://app.circleci.com/[CircleCI web app], navigate to *Self-Hosted Runners* and select btn:[Create Resource Class].
. On the https://app.circleci.com/[CircleCI web app], navigate to *Runners* and select btn:[Create Resource Class].
+
image::guides:ROOT:runner/runner-ui-step-one.png[Runner set up, step one - Get started]

Expand Down
6 changes: 3 additions & 3 deletions docs/guides/modules/ROOT/partials/runner/terms.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@ Web app installation::
+
--

Before you can install self-hosted runners through the web app, you will need to agree to the https://circleci.com/legal/runner-terms/[CircleCI Runner Terms]. To access the *Self-Hosted Runners* section of the https://app.circleci.com/[CircleCI web app] an organization admin must agree to the terms at menu:Organization Settings[Self-Hosted Runners].
Before you can install self-hosted runners through the web app, you will need to agree to the https://circleci.com/legal/runner-terms/[CircleCI Runner Terms]. To access the *Runners* section of the https://app.circleci.com/[CircleCI web app] an organization admin must agree to the terms at menu:Org[Runners].

.Runner terms and conditions
image::guides:ROOT:runnerui_terms.png[Runner terms and conditions]

Once the terms have been accepted, **Self-Hosted Runners** will appear permanently in the side navigation.
Once the terms have been accepted, **Runners** will appear permanently in the side navigation.

Your role within your org is determined differently depending on how you integrate with your code, as follows:

* If you have a `github` or `bitbucket` type organization, CircleCI mirrors VCS permissions for organizations. If you are an admin on your organization's VCS, you are an admin on CircleCI. If you are unsure, https://support.circleci.com/hc/en-us/articles/360034990033-Am-I-an-Org-Admin[check the admin permissions] on your VCS.

* If you have a `circleci` type organization, you can check roles by navigating to menu:Organization Settings[People]. Full details on roles and permissions are available in the xref:guides:permissions-authentication:roles-and-permissions-overview.adoc[Roles and Permissions Overview].
* If you have a `circleci` type organization, you can check roles by navigating to menu:Org[People]. Full details on roles and permissions are available in the xref:guides:permissions-authentication:roles-and-permissions-overview.adoc[Roles and Permissions Overview].

TIP: Find out about organization types in the xref:guides:permissions-authentication:users-organizations-and-integrations-guide.adoc[Users, Organizations and Integrations Guide].
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ image::guides:ROOT:user_settings.png[User settings]

== Organization homepage and navigation

After selecting an organization you will find yourself on the Organization homepage, or Dashboard if you are using CircleCI Server. The organization homepage provides an overview of your org's projects, project health metrics, and compute and credit usage metrics for your org.
After selecting an organization you will find yourself on the organization homepage (called **Home** in the sidebar), or Dashboard if you are using CircleCI Server. The organization homepage provides an overview of your org's projects, project health metrics, and compute and credit usage metrics for your org.

.Organization Homepage
image::guides:ROOT:org-homepage.png[Organization homepage]
Expand All @@ -109,9 +109,9 @@ From your organization home page you have access to org-level options. You can c

**Insights**: Provides you with time-series data overviews of credit usage, success rates, pipeline duration, and more. For full details of the Insights feature, see the xref:insights:insights.adoc[Using Insights] page.

**Self-Hosted Runners**: Set up self-hosted runners to use your own infrastructure for running jobs. Once set up the self-hosted runners dashboard displays a list of your resource classes and self-hosted runners. For full details covering installation, setup, and usage, see the xref:execution-runner:runner-overview.adoc[Self-Hosted Runners Overview] page.
**Runners**: Set up self-hosted runners to use your own infrastructure for running jobs. Once set up the self-hosted runners dashboard displays a list of your resource classes and self-hosted runners. For full details covering installation, setup, and usage, see the xref:execution-runner:runner-overview.adoc[Self-Hosted Runners Overview] page.

**Organization Settings**: Settings for your organization including org roles and groups, contexts, security, orbs and more. You can find your organization ID and organization slug on this page.
**Org**: Settings for your organization including org roles and groups, contexts, security, orbs and more. You can find your organization ID and organization slug on this page.

**Plan**: Displays your network and storage usage, as well as additional settings related to your plan.

Expand Down Expand Up @@ -285,7 +285,7 @@ Learn more and get started with self-hosted runners on the xref:execution-runner
[#organization-settings]
== Organization settings

The following organization settings are available by selection "Organization Settings" in the sidebar:
The following organization settings are available by selecting "Org" in the sidebar:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following organization settings are available by selecting "Org" in the sidebar:
The following organization settings are available by selecting *Org* from the sidebar:


[.table-scroll]
--
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ In the following steps you will replace `namespace/resource_class` and `project_
== 2. Update policy with your details

. Replace `namespace/resource_class` with one of your runner resource classes:
.. In the CircleCI web app, go to your self-hosted runner's inventory page by selecting **Self-Hosted Runners** in the sidebar. If you do not see this option, check that you have accepted the CircleCI Runner Terms and created a namespace and resource class, as outlined in the runner installation guides. Here you will see all your available self-hosted runner resource classes.
.. In the CircleCI web app, go to your self-hosted runner's inventory page by selecting **Runners** in the sidebar. If you do not see this option, check that you have accepted the CircleCI Runner Terms and created a namespace and resource class, as outlined in the runner installation guides. Here you will see all your available self-hosted runner resource classes.
.. Replace `namespace/resource_class` in the `runner.rego` file with the name of the resource class that you would like to restrict.

. Replace `project_UUIDs` with a project ID:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ machine:

If you need immediate relief to restore workflows during an active brownout, you can temporarily disable brownouts.

Navigate to *Organization Settings > Advanced > Enable resource class brownouts* and toggle the setting off.
Navigate to *Org > Advanced > Enable resource class brownouts* and toggle the setting off.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Navigate to *Org > Advanced > Enable resource class brownouts* and toggle the setting off.
Navigate to menu:Org[Advanced > Enable resource class brownouts] and toggle the setting off.


[IMPORTANT]
====
Expand Down
Loading