Merge pull request #17372 from github/repo-sync

repo sync

Author: Octomerger

assets/images/help/codespaces/add-constraint-dropdown-ports.png

@@ -12,6 +12,8 @@ shortTitle: Set the timeout
 
 A codespace will stop running after a period of inactivity. You can specify the length of this timeout period. The updated setting will apply to any newly created codespace.
 
+Some organizations may have a maximum idle timeout policy. If an organization policy sets a maximum timeout which is less than the default timeout you have set, the organization's timeout will be used instead of your setting, and you will be notified of this after the codespace is created. For more information, see "[Restricting the idle timeout period](/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period)."
+
 {% warning %}
 
 **Warning**: Codespaces are billed per minute. If you are not actively using a codespace but the codespace has not yet timed out, you are still billed for the time that the codespace is running. For more information, see "[About billing for Codespaces](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#codespaces-pricing)."

assets/images/help/codespaces/add-constraint-dropdown-timeout.png

@@ -15,6 +15,7 @@ children:
   - /reviewing-your-organizations-audit-logs-for-codespaces
   - /restricting-access-to-machine-types
   - /restricting-the-visibility-of-forwarded-ports
+  - /restricting-the-idle-timeout-period
 shortTitle: Managing your organization
 ---
 

assets/images/help/codespaces/add-constraint-dropdown.png

@@ -1,9 +1,9 @@
 ---
 title: Restricting access to machine types
-shortTitle: Machine type access
+shortTitle: Restrict machine types
 intro: You can set constraints on the types of machines users can choose when they create codespaces in your organization.
 product: '{% data reusables.gated-features.codespaces %}'
-permissions: 'To manage access to machine types for the repositories in an organization, you must be an organization owner.'
+permissions: 'To manage access to machine types for the repositories in an organization, you must be an owner of the organization.'
 versions:
   fpt: '*'
   ghec: '*'
@@ -47,33 +47,22 @@ If you add an organization-wide policy, you should set it to the largest choice
 
 {% data reusables.profile.access_org %}
 {% data reusables.profile.org_settings %}
-1. In the "Code, planning, and automation" section of the sidebar, select **{% octicon "codespaces" aria-label="The codespaces icon" %} {% data variables.product.prodname_codespaces %}** then click **Policy**.
-2. On the "Codespace policies" page, click **Create Policy**.
-3. Enter a name for your new policy.
-4. Click **Add constraint** and choose **Machine types**.
+{% data reusables.codespaces.codespaces-org-policies %}
+1. Click **Add constraint** and choose **Machine types**.
 
    ![Add a constraint for machine types](/assets/images/help/codespaces/add-constraint-dropdown.png)
 
-5. Click {% octicon "pencil" aria-label="The edit icon" %} to edit the constraint, then clear the selection of any machine types that you don't want to be available.
+1. Click {% octicon "pencil" aria-label="The edit icon" %} to edit the constraint, then clear the selection of any machine types that you don't want to be available.
 
    ![Edit the machine type constraint](/assets/images/help/codespaces/edit-machine-constraint.png)
 
-6. In the "Change policy target" area, click the dropdown button.
-7. Choose either **All repositories** or **Selected repositories** to determine which repositories this policy will apply to.
-8. If you chose **Selected repositories**:
-   1. Click {% octicon "gear" aria-label="The settings icon" %}.
-
-      ![Edit the settings for the policy](/assets/images/help/codespaces/policy-edit.png)
-
-   2. Select the repositories you want this policy to apply to.
-   3. At the bottom of the repository list, click **Select repositories**.
-
-      ![Select repositories for this policy](/assets/images/help/codespaces/policy-select-repos.png)
-
-9. Click **Save**.
-
+{% data reusables.codespaces.codespaces-policy-targets %}
+1. If you want to add another constraint to the policy, click **Add constraint** and choose another constraint. For information about other constraints, see "[Restricting the visibility of forwarded ports](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)" and "[Restricting the idle timeout period](/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period)."
+1. After you have finished adding constraints to your policy, click **Save**.
 ## Editing a policy
 
+You can edit an existing policy. For example, you may want to add or remove constraints to or from a policy.
+
 1. Display the "Codespace policies" page. For more information, see "[Adding a policy to limit the available machine types](#adding-a-policy-to-limit-the-available-machine-types)."
 1. Click the name of the policy you want to edit.
 1. Make the required changes then click **Save**.

assets/images/help/codespaces/edit-timeout-constraint.png

@@ -0,0 +1,79 @@
+---
+title: Restricting the idle timeout period
+shortTitle: Restrict timeout periods
+intro: 'You can set a maximum timeout period for any codespaces owned by your organization.'
+product: '{% data reusables.gated-features.codespaces %}'
+permissions: 'To manage timeout constraints for an organization''s codespaces, you must be an owner of the organization.'
+versions:
+  fpt: '*'
+  ghec: '*'
+type: how_to
+topics:
+  - Codespaces
+---
+
+## Overview
+
+By default, codespaces time out after 30 minutes of inactivity. When a codespace times out it is stopped and will no longer incur charges for compute usage. 
+
+The personal settings of a {% data variables.product.prodname_dotcom %} user allow them to define their own timeout period for codespaces they create. This may be longer than the default 30-minute period. For more information, see "[Setting your timeout period for Codespaces](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-codespaces)."
+
+As an organization owner, you may want to configure constraints on the maximum idle timeout period for codespaces owned by your organization. This can help you limit costs associated with codespaces that are left to timeout after long periods of inactivity. You can set a maximum timeout for all codespaces owned by your organization, or for the codespaces of specific repositories. 
+
+{% note %}
+
+**Note**: Maximum idle timeout constraints only apply to codespaces that are owned by your organization.
+
+{% endnote %}
+
+For more information about pricing for {% data variables.product.prodname_codespaces %} compute usage, see "[About billing for Codespaces](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#codespaces-pricing)."
+
+### Behavior when you set a maximum idle timeout constraint
+
+If someone sets the default idle timeout to 90 minutes in their personal settings and they then start a codespace for a repository with a maximum idle timeout constraint of 60 minutes, the codespace will time out after 60 minutes of inactivity. When codespace creation completes, a message explaining this will be displayed:
+
+> Idle timeout for this codespace is set to 60 minutes in compliance with your organization’s policy.
+
+### Setting organization-wide and repository-specific policies
+
+When you create a policy, you choose whether it applies to all repositories in your organization, or only to specified repositories. If you create an organization-wide policy with a timeout constraint, then the timeout constraints in any policies that are targeted at specific repositories must fall within the restriction configured for the entire organization. The shortest timeout period - in an organization-wide policy, a policy targeted at specified repositories, or in someone's personal settings - is applied.
+
+If you add an organization-wide policy with a timeout constraint, you should set the timeout to the longest acceptable period. You can then add separate policies that set the maximum timeout to a shorter period for specific repositories in your organization.
+
+## Adding a policy to set a maximum idle timeout period
+
+{% data reusables.profile.access_org %}
+{% data reusables.profile.org_settings %}
+{% data reusables.codespaces.codespaces-org-policies %}
+1. Click **Add constraint** and choose **Maximum idle timeout**.
+
+   ![Add a constraint for idle timeout](/assets/images/help/codespaces/add-constraint-dropdown-timeout.png)
+
+1. Click {% octicon "pencil" aria-label="The edit icon" %} to edit the constraint.
+
+   ![Edit the timeout constraint](/assets/images/help/codespaces/edit-timeout-constraint.png)
+
+1. Enter the maximum number of minutes codespaces can remain inactive before they time out, then click **Save**.
+
+   ![Choose the port visibility options](/assets/images/help/codespaces/maximum-minutes-timeout.png)
+
+{% data reusables.codespaces.codespaces-policy-targets %}
+1. If you want to add another constraint to the policy, click **Add constraint** and choose another constraint. For information about other constraints, see "[Restricting access to machine types](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)" and "[Restricting the visibility of forwarded ports](/codespaces/managing-codespaces-for-your-organization/restricting-the-visibility-of-forwarded-ports)."
+1. After you have finished adding constraints to your policy, click **Save**.
+
+The policy will be applied to all new codespaces that are created, and to existing codespaces the next time they are started.
+
+## Editing a policy
+
+You can edit an existing policy. For example, you may want to add or remove constraints to or from a policy.
+
+1. Display the "Codespace policies" page. For more information, see "[Adding a policy to set a maximum idle timeout period](#adding-a-policy-to-set-a-maximum-idle-timeout-period)."
+1. Click the name of the policy you want to edit.
+1. Make the required changes then click **Save**.
+
+## Deleting a policy 
+
+1. Display the "Codespace policies" page. For more information, see "[Adding a policy to set a maximum idle timeout period](#adding-a-policy-to-set-a-maximum-idle-timeout-period)."
+1. Click the delete button to the right of the policy you want to delete.
+
+   ![The delete button for a policy](/assets/images/help/codespaces/policy-delete.png)

assets/images/help/codespaces/maximum-minutes-timeout.png

@@ -1,9 +1,9 @@
 ---
 title: Restricting the visibility of forwarded ports
-shortTitle: Restricting port visibility
+shortTitle: Restrict port visibility
 intro: 'You can set constraints on the visibility options users can choose when they forward ports from codespaces in your organization.'
 product: '{% data reusables.gated-features.codespaces %}'
-permissions: 'To manage access to port visibility constraints for the repositories in an organization, you must be an organization owner.'
+permissions: 'To manage access to port visibility constraints for the repositories in an organization, you must be an owner of the organization.'
 versions:
   fpt: '*'
   ghec: '*'
@@ -40,37 +40,26 @@ If you add an organization-wide policy, you should set it to the most lenient vi
 
 {% data reusables.profile.access_org %}
 {% data reusables.profile.org_settings %}
-1. In the "Code, planning, and automation" section of the sidebar, select **{% octicon "codespaces" aria-label="The codespaces icon" %} {% data variables.product.prodname_codespaces %}** then click **Policies**.
-1. On the "Codespace policies" page, click **Create Policy**.
-1. Enter a name for your new policy.
+{% data reusables.codespaces.codespaces-org-policies %}
 1. Click **Add constraint** and choose **Port visibility**.
 
    ![Add a constraint for port visibility](/assets/images/help/codespaces/add-constraint-dropdown-ports.png)
 
-1. Click {% octicon "pencil" aria-label="The edit icon" %} to edit the constraint
+1. Click {% octicon "pencil" aria-label="The edit icon" %} to edit the constraint.
 
    ![Edit the port visibility constraint](/assets/images/help/codespaces/edit-port-visibility-constraint.png)
 
 1. Clear the selection of the port visibility options (**Org** or **Public**) that you don't want to be available.
 
    ![Choose the port visibility options](/assets/images/help/codespaces/choose-port-visibility-options.png)
 
-1. In the "Change policy target" area, click the dropdown button.
-1. Choose either **All repositories** or **Selected repositories** to determine which repositories this policy will apply to.
-1. If you chose **Selected repositories**:
-   1. Click {% octicon "gear" aria-label="The settings icon" %}.
-
-      ![Edit the settings for the policy](/assets/images/help/codespaces/policy-edit.png)
-
-   2. Select the repositories you want this policy to apply to.
-   3. At the bottom of the repository list, click **Select repositories**.
-
-      ![Select repositories for this policy](/assets/images/help/codespaces/policy-select-repos.png)
-
-1. Click **Save**.
-
+{% data reusables.codespaces.codespaces-policy-targets %}
+1. If you want to add another constraint to the policy, click **Add constraint** and choose another constraint. For information about other constraints, see "[Restricting access to machine types](/codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types)" and "[Restricting the idle timeout period](/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period)."
+1. After you have finished adding constraints to your policy, click **Save**.
 ## Editing a policy
 
+You can edit an existing policy. For example, you may want to add or remove constraints to or from a policy.
+
 1. Display the "Codespace policies" page. For more information, see "[Adding a policy to limit the port visibility options](#adding-a-policy-to-limit-the-port-visibility-options)."
 1. Click the name of the policy you want to edit.
 1. Make the required changes then click **Save**.