diff --git a/Dockerfile b/Dockerfile index 8882d15b2980..be603a154943 100644 --- a/Dockerfile +++ b/Dockerfile @@ -8,7 +8,7 @@ # --------------------------------------------------------------- # To update the sha: # https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble -FROM ghcr.io/github/gh-base-image/gh-base-noble:20250625-211326-g8ecab2454 AS base +FROM ghcr.io/github/gh-base-image/gh-base-noble:20250625-232939-g2376d80a2 AS base # Install curl for Node install and determining the early access branch # Install git for cloning docs-early-access & translations repos diff --git a/content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md b/content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md index bac7dab425e6..428371fca003 100644 --- a/content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md +++ b/content/code-security/dependabot/working-with-dependabot/dependabot-options-reference.md @@ -737,3 +737,127 @@ All sensitive data used for authentication should be stored securely and referen The `url` parameter defines where to access a registry. When the optional `replaces-base` parameter is enabled (`true`), {% data variables.product.prodname_dependabot %} resolves dependencies using the value of `url` rather than the base URL of that specific ecosystem. {% data reusables.dependabot.dependabot-replaces-base-nuget %} + +## `cooldown` {% octicon "versions" aria-label="cooldown" height="24" %} + +Defines a **cooldown period** for dependency updates to delay updates for a configurable number of days. This feature enables dependabot users to customize how often they receive new version updates, offering greater control over update frequency. + +> [!NOTE] +> Cooldown is not applicable for security updates. + +### **How Cooldown Works** + +* When Dependabot runs updates as per defined schedule, it checks the **cooldown settings** to determine if new release for dependency is still within its cooldown period. +* If new version release date is within the cooldown period, dependency version update is **filtered out** and will not be updated until the cooldown period expires. +* Once the cooldown period ends for new version, the dependency update proceeds based on the standard update strategy defined in `dependabot.yml`. + +Without **`cooldown`** (default behaviour): {% data variables.product.prodname_dependabot %} + +* Dependabot checks for updates according to the scheduled defined via `schedule.interval`. +* All new versions are considered for updates **immediately**. + +With **`cooldown`** enabled: + +* Dependabot checks for updates based on the defined `schedule.interval` settings. +* **Releases within the cooldown period are ignored.** +* Dependabot updates the dependency to the latest available version **that are no longer in cooldown period** following the configured `versioning-strategy`. + +### **Cooldown Configuration** + +| Parameter | Description | +|-----------|-------------| +| `default-days` | **Default cooldown period for dependencies** without specific rules (optional). | +| `semver-major-days` | Cooldown period for **major version updates** (optional, applies only to SEMVER-supported package managers). | +| `semver-minor-days` | Cooldown period for **minor version updates** (optional, applies only to SEMVER-supported package managers). | +| `semver-patch-days` | Cooldown period for **patch version updates** (optional, applies only to SEMVER-supported package managers). | +| `include` | List of dependencies to **apply cooldown** (up to **150 items**). Supports wildcards (`*`). | +| `exclude` | List of dependencies **excluded from cooldown** (up to **150 items**). Supports wildcards (`*`). | + +### **semver versioning** + +| Package Manager | SEMVER Supported | +|-----------------------|------------------| +| **Bundler** | Yes | +| **Bun** | Yes | +| **Cargo** | Yes | +| **Composer** | Yes | +| **Devcontainers** | No | +| **Docker** | No | +| **Docker Compose** | No | +| **Dotnet SDK** | Yes | +| **Elm** | Yes | +| **Github Actions** | No | +| **Gitsubmodule** | No | +| **Gomod (Go Modules)**| Yes | +| **Gradle** | Yes | +| **Helm** | No | +| **Hex (Hex)** | Yes | +| **Maven** | Yes | +| **NPM and Yarn** | Yes | +| **Pip** | Yes | +| **Pub** | Yes | +| **Swift** | Yes | +| **Terraform** | No | +| **UV** | Yes | + +> [!NOTE] +> +> * If `semver-major-days`, `semver-minor-days`, or `semver-patch-days` are not defined, `default-days` settings take precedence for cooldown based updates. +> * `semver-major-days`, `semver-minor-days`, and `semver-patch-days` are only applicable for [supported package managers](#semver-versioning). +> * The `exclude` list always take precedence over the `include` list. If a dependency is specified in both lists, it is excluded from cooldown and will be updated immediately. + +### **Cooldown settings limitations** + +* `days` must be between 1 and 90. +* Maximum allowed items limit in `include` and `exclude` list is 150 each. + +### **Example `dependabot.yml` with cooldown** + +```yaml copy + +version: 2 +updates: + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "daily" + cooldown: + default-days: 5 + semver-major-days: 30 + semver-minor-days: 7 + semver-patch-days: 3 + include: + - "requests" + - "numpy" + - "pandas*" + - "django" + exclude: + - "pandas" +``` + +### **Expected Behavior** + +Cooldown will be active for dependencies `requests`, `numpy` and dependencies starting with `pandas`, and `django`. Dependency with exact name `pandas` will be excluded from cooldown based updates as it is present in **exclude** list. + +#### **Update days** + +Updates to new versions for included dependencies will be deferred as following: + +* **Major updates** → Delayed by **30 days** (`semver-major-days: 30`) +* **Minor updates** → Delayed by **7 days** (`semver-minor-days: 7`) +* **Patch updates** → Delayed by **3 days** (`semver-patch-days: 3`) + +**Wildcard Matching:** + +* `"pandas*"` applies cooldown to all dependencies that start with `pandas`. +* `"pandas"` in `exclude` ensures that only `"pandas"` (exact match) is excluded from cooldown. + +> [!NOTE] +> To consider all dependencies for cooldown, you can: +> +> * Omit the `include` option which applies cooldown to all dependencies. +> * Use `"*"` in `include` to apply cooldown to everything. +> +> Use **only** `exclude` setting if specific dependencies are to be excluded from cooldown. + +{% data reusables.dependabot.option-affects-security-updates %} diff --git a/content/copilot/concepts/copilot-billing/index.md b/content/copilot/concepts/copilot-billing/index.md index ce16639543c7..546a7f0090b0 100644 --- a/content/copilot/concepts/copilot-billing/index.md +++ b/content/copilot/concepts/copilot-billing/index.md @@ -14,5 +14,6 @@ children: - /about-billing-for-github-copilot-in-your-enterprise redirect_from: - /managing-copilot/managing-copilot-as-an-individual-subscriber/billing-and-payments + - /copilot/managing-copilot/understanding-and-managing-copilot-usage --- diff --git a/content/copilot/concepts/index.md b/content/copilot/concepts/index.md index de6b55e99c80..a7fffaf81f38 100644 --- a/content/copilot/concepts/index.md +++ b/content/copilot/concepts/index.md @@ -14,7 +14,5 @@ children: - /indexing-repositories-for-copilot-chat - /about-organizing-and-sharing-context-with-copilot-spaces - /build-copilot-extensions -redirect_from: - - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/billing-and-payments --- diff --git a/content/copilot/customizing-copilot/index.md b/content/copilot/customizing-copilot/index.md deleted file mode 100644 index e7b52a4b2ab3..000000000000 --- a/content/copilot/customizing-copilot/index.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Customizing Copilot -shortTitle: Customize Copilot -intro: 'You can customize {% data variables.product.prodname_copilot %} to make it fit your specific needs.' -versions: - feature: copilot -topics: - - Copilot -children: - - /using-model-context-protocol - - /extending-the-capabilities-of-github-copilot-in-your-organization - - /adding-personal-custom-instructions-for-github-copilot - - /adding-repository-custom-instructions-for-github-copilot - - /adding-organization-custom-instructions-for-github-copilot - - /customizing-the-development-environment-for-copilot-coding-agent - - /customizing-or-disabling-the-firewall-for-copilot-coding-agent - - /managing-copilot-knowledge-bases - - /creating-a-custom-model-for-github-copilot -redirect_from: - - /copilot/managing-copilot/managing-github-copilot-in-your-organization/customizing-copilot-for-your-organization - - /copilot/managing-copilot/managing-github-copilot-in-your-organization/enhancing-copilot-for-your-organization ---- - diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/index.md b/content/copilot/how-tos/administer/enterprises/index.md similarity index 88% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/index.md rename to content/copilot/how-tos/administer/enterprises/index.md index f991e4248681..097510b071c2 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/index.md +++ b/content/copilot/how-tos/administer/enterprises/index.md @@ -11,4 +11,7 @@ children: - /managing-access-to-copilot-in-your-enterprise - /managing-policies-and-features-for-copilot-in-your-enterprise - /managing-copilot-coding-agent-in-your-enterprise +redirect_from: + - /copilot/managing-copilot/managing-copilot-for-your-enterprise --- + diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md similarity index 92% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md rename to content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md index 925cff7320a4..2f52703d73a4 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise.md @@ -10,6 +10,7 @@ topics: - Copilot redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/disabling-copilot-for-organizations-in-your-enterprise --- {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md similarity index 94% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md rename to content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md index fef9504b208a..a155fb855a96 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise.md @@ -10,6 +10,7 @@ topics: - Copilot redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/enabling-copilot-for-organizations-in-your-enterprise --- Owners of enterprises that have a {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} plan can enable {% data variables.product.prodname_copilot %} for all, none, or some organizations within the enterprise. diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/index.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/index.md similarity index 80% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/index.md rename to content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/index.md index 13fd5caab29b..3b5bdeee7cc2 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/index.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/index.md @@ -11,5 +11,7 @@ children: - /disabling-copilot-for-organizations-in-your-enterprise - /viewing-copilot-license-usage-in-your-enterprise - /managing-github-copilot-access-to-your-enterprises-network +redirect_from: + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise --- diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md similarity index 73% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md rename to content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md index 1a3032b1e12e..4017603e9b6a 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network.md @@ -8,6 +8,8 @@ versions: topics: - Copilot shortTitle: Manage network access +redirect_from: + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/managing-github-copilot-access-to-your-enterprises-network --- {% data reusables.copilot.sku-isolation %} diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md similarity index 97% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md rename to content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md index cf501abc2613..a8b9b873f77e 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise.md @@ -13,6 +13,7 @@ redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/viewing-your-github-copilot-usage - /copilot/managing-copilot/managing-copilot-for-your-enterprise/viewing-copilot-usage-for-your-enterprise - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-usage-for-your-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-access-to-copilot-in-your-enterprise/viewing-copilot-license-usage-in-your-enterprise --- ## About your {% data variables.product.prodname_copilot %} usage diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-copilot-coding-agent-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-copilot-coding-agent-in-your-enterprise.md similarity index 97% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-copilot-coding-agent-in-your-enterprise.md rename to content/copilot/how-tos/administer/enterprises/managing-copilot-coding-agent-in-your-enterprise.md index 79abbd7dd9b4..2ed8fae7ded4 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-copilot-coding-agent-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-copilot-coding-agent-in-your-enterprise.md @@ -12,6 +12,7 @@ shortTitle: 'Manage {% data variables.copilot.copilot_coding_agent %}' redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/adding-copilot-coding-agent-to-enterprise - /copilot/managing-copilot/managing-copilot-for-your-enterprise/making-copilot-coding-agent-available-to-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-copilot-coding-agent-in-your-enterprise --- {% data reusables.copilot.coding-agent.preview-note %} diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-policies-and-features-for-copilot-in-your-enterprise.md similarity index 98% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise.md rename to content/copilot/how-tos/administer/enterprises/managing-policies-and-features-for-copilot-in-your-enterprise.md index 01244249efbd..d178a651e719 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-policies-and-features-for-copilot-in-your-enterprise.md @@ -8,6 +8,8 @@ versions: topics: - Copilot shortTitle: Manage policies +redirect_from: + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise --- ## About policies for {% data variables.product.prodname_copilot %} in your enterprise diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md similarity index 84% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md rename to content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md index 6d6801b53c73..f7e70a3683ad 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise.md @@ -11,6 +11,7 @@ topics: redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/canceling-copilot-for-your-enterprise - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/canceling-copilot-for-your-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/canceling-copilot-for-your-enterprise --- {% data reusables.copilot.disable-copilot-for-all-orgs %} diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md similarity index 90% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md rename to content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md index f0c564a20420..174b42dce64e 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise.md @@ -11,6 +11,7 @@ topics: redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/downgrading-copilot-for-your-enterprise - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/downgrading-copilot-for-your-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/downgrading-copilot-for-your-enterprise --- {% data reusables.enterprise-accounts.access-enterprise %} diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/index.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/index.md similarity index 86% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/index.md rename to content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/index.md index a03867619978..2e708f4b2000 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/index.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/index.md @@ -14,5 +14,6 @@ children: redirect_from: - /managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise --- diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md similarity index 94% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md rename to content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md index 5e102151b2a1..22bfd67a9736 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise.md @@ -12,6 +12,7 @@ redirect_from: - /billing/managing-billing-for-github-copilot/managing-your-github-copilot-enterprise-subscription - /copilot/managing-copilot/managing-copilot-for-your-enterprise/subscribing-to-copilot-for-your-enterprise - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/subscribing-to-copilot-for-your-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/subscribing-to-copilot-for-your-enterprise --- >[!NOTE] diff --git a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md similarity index 93% rename from content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md rename to content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md index c878a7c5d37c..e5414a11be6d 100644 --- a/content/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md +++ b/content/copilot/how-tos/administer/enterprises/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise.md @@ -11,6 +11,7 @@ topics: redirect_from: - /copilot/managing-copilot/managing-copilot-for-your-enterprise/upgrading-copilot-for-your-enterprise - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-subscription-for-your-enterprise/upgrading-copilot-for-your-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-the-copilot-plan-for-your-enterprise/upgrading-copilot-for-your-enterprise --- >[!NOTE] diff --git a/content/copilot/how-tos/administer/index.md b/content/copilot/how-tos/administer/index.md new file mode 100644 index 000000000000..630285825852 --- /dev/null +++ b/content/copilot/how-tos/administer/index.md @@ -0,0 +1,13 @@ +--- +title: Administer GitHub Copilot for your team +shortTitle: Administer +intro: 'Learn how to administer {% data variables.product.prodname_copilot %} for your organization or enterprise.' +versions: + feature: copilot +topics: + - Copilot +children: + - /organizations + - /enterprises +--- + diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization.md b/content/copilot/how-tos/administer/organizations/adding-copilot-coding-agent-to-organization.md similarity index 97% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization.md rename to content/copilot/how-tos/administer/organizations/adding-copilot-coding-agent-to-organization.md index 3340ed98b611..bb14b2b0d995 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization.md +++ b/content/copilot/how-tos/administer/organizations/adding-copilot-coding-agent-to-organization.md @@ -9,6 +9,8 @@ versions: topics: - Copilot shortTitle: 'Add {% data variables.copilot.copilot_coding_agent %}' +redirect_from: + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization --- {% data reusables.copilot.coding-agent.preview-note %} diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot.md b/content/copilot/how-tos/administer/organizations/configuring-your-proxy-server-or-firewall-for-copilot.md similarity index 96% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot.md rename to content/copilot/how-tos/administer/organizations/configuring-your-proxy-server-or-firewall-for-copilot.md index 687802c2d7aa..009ee370b23e 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot.md +++ b/content/copilot/how-tos/administer/organizations/configuring-your-proxy-server-or-firewall-for-copilot.md @@ -1,12 +1,14 @@ --- title: Configuring your proxy server or firewall for Copilot intro: 'You should allow certain traffic through your firewall or proxy server for {% data variables.product.prodname_copilot_short %} to work as intended.' -permissions: 'Proxy server maintainers or firewall maintainers' +permissions: Proxy server maintainers or firewall maintainers versions: feature: copilot topics: - Copilot shortTitle: Allow Copilot traffic +redirect_from: + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/configuring-your-proxy-server-or-firewall-for-copilot --- If your company employs security measures like a firewall or proxy server, you should add the following URLs, ports, and protocols to an allowlist to ensure {% data variables.product.prodname_copilot_short %} works as expected: diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/index.md b/content/copilot/how-tos/administer/organizations/index.md similarity index 92% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/index.md rename to content/copilot/how-tos/administer/organizations/index.md index ec8453ed431a..4270065cbfae 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/index.md +++ b/content/copilot/how-tos/administer/organizations/index.md @@ -7,6 +7,7 @@ versions: redirect_from: - /copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization - /copilot/managing-github-copilot-in-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization topics: - Copilot children: @@ -17,3 +18,4 @@ children: - /adding-copilot-coding-agent-to-organization - /reviewing-activity-related-to-github-copilot-in-your-organization --- + diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md similarity index 97% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md rename to content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md index e49bd98b0bdc..4d40dedf8651 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md +++ b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization.md @@ -12,6 +12,7 @@ redirect_from: - /copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization - /copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization - /copilot/managing-copilot/managing-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/granting-access-to-copilot-for-members-of-your-organization topics: - Copilot --- diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/index.md b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/index.md similarity index 84% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/index.md rename to content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/index.md index 388564a4e7f6..e7e879e5bcf3 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/index.md +++ b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/index.md @@ -13,5 +13,6 @@ children: - /managing-github-copilot-access-to-your-organizations-network redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-github-copilot-activity-in-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization --- diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network.md b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network.md similarity index 68% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network.md rename to content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network.md index 91918bd0a517..5cc13c5a7a13 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network.md +++ b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network.md @@ -8,6 +8,8 @@ versions: topics: - Copilot shortTitle: Manage network access +redirect_from: + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-github-copilot-access-to-your-organizations-network --- {% data reusables.copilot.sku-isolation %} diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-business-in-your-organization.md b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-business-in-your-organization.md similarity index 77% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-business-in-your-organization.md rename to content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-business-in-your-organization.md index 21965b8bef9d..d811508470c2 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-business-in-your-organization.md +++ b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-business-in-your-organization.md @@ -4,8 +4,9 @@ shortTitle: Manage requests for access intro: 'Approve or deny requests for {% data variables.product.prodname_copilot_short %} access in your organization.' permissions: Organization owners redirect_from: - - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-requests-for-copilot-access-in-your-organization - - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-access-in-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-requests-for-copilot-access-in-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-access-in-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/managing-requests-for-copilot-business-in-your-organization product: 'Organizations with a {% data variables.copilot.copilot_business_short %} plan and organizations owned by an enterprise with a {% data variables.copilot.copilot_business_short %} plan' versions: feature: copilot diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md similarity index 95% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md rename to content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md index 1151d4cee928..3a68442e6fa0 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md +++ b/content/copilot/how-tos/administer/organizations/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization.md @@ -10,6 +10,7 @@ topics: redirect_from: - /copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization - /copilot/managing-copilot/managing-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization --- ## How revoking access affects billing diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization.md b/content/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization.md similarity index 98% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization.md rename to content/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization.md index de5f49f21fd5..159544004ff9 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization.md +++ b/content/copilot/how-tos/administer/organizations/managing-policies-for-copilot-in-your-organization.md @@ -17,6 +17,7 @@ redirect_from: - /copilot/github-copilot-chat/copilot-chat-in-github-mobile/enabling-github-copilot-chat-for-github-mobile - /copilot/github-copilot-chat/github-copilot-extensions/managing-github-copilot-extensions - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-policies-for-copilot-in-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization topics: - Copilot shortTitle: Manage policies diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/canceling-copilot-for-your-organization.md b/content/copilot/how-tos/administer/organizations/managing-the-copilot-plan-for-your-organization/canceling-copilot-for-your-organization.md similarity index 88% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/canceling-copilot-for-your-organization.md rename to content/copilot/how-tos/administer/organizations/managing-the-copilot-plan-for-your-organization/canceling-copilot-for-your-organization.md index ee0688c80697..1cb62a41d7b4 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/canceling-copilot-for-your-organization.md +++ b/content/copilot/how-tos/administer/organizations/managing-the-copilot-plan-for-your-organization/canceling-copilot-for-your-organization.md @@ -11,6 +11,7 @@ topics: redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/canceling-copilot-for-your-organization - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/canceling-copilot-for-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/canceling-copilot-for-your-organization --- {% ifversion ghec %} diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/index.md b/content/copilot/how-tos/administer/organizations/managing-the-copilot-plan-for-your-organization/index.md similarity index 80% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/index.md rename to content/copilot/how-tos/administer/organizations/managing-the-copilot-plan-for-your-organization/index.md index 24df0e5de691..a5b42e0383b8 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/index.md +++ b/content/copilot/how-tos/administer/organizations/managing-the-copilot-plan-for-your-organization/index.md @@ -11,5 +11,6 @@ children: - /canceling-copilot-for-your-organization redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization --- diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/subscribing-to-copilot-for-your-organization.md b/content/copilot/how-tos/administer/organizations/managing-the-copilot-plan-for-your-organization/subscribing-to-copilot-for-your-organization.md similarity index 91% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/subscribing-to-copilot-for-your-organization.md rename to content/copilot/how-tos/administer/organizations/managing-the-copilot-plan-for-your-organization/subscribing-to-copilot-for-your-organization.md index 420e46eae6c8..0b073a95771b 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/subscribing-to-copilot-for-your-organization.md +++ b/content/copilot/how-tos/administer/organizations/managing-the-copilot-plan-for-your-organization/subscribing-to-copilot-for-your-organization.md @@ -12,6 +12,7 @@ redirect_from: - /billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise - /copilot/managing-copilot/managing-github-copilot-in-your-organization/subscribing-to-copilot-for-your-organization - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-plan-for-your-organization/subscribing-to-copilot-for-your-organization --- {% ifversion ghec %} diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/index.md b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/index.md similarity index 71% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/index.md rename to content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/index.md index 319f8b7e59e8..2bbe39b762b4 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/index.md +++ b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/index.md @@ -9,4 +9,7 @@ topics: children: - /reviewing-user-activity-data-for-copilot-in-your-organization - /reviewing-audit-logs-for-copilot-business +redirect_from: + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization --- + diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md similarity index 95% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md rename to content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md index 77b905f1b4cf..1751f217aee9 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md +++ b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business.md @@ -10,6 +10,7 @@ redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business - /copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-github-copilot-activity-in-your-organization/reviewing-audit-logs-for-copilot-business - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-audit-logs-for-copilot-business versions: feature: copilot product: '{% data reusables.gated-features.copilot-audit-logs %}' diff --git a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md similarity index 96% rename from content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md rename to content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md index c6921aa30617..37b194994f36 100644 --- a/content/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md +++ b/content/copilot/how-tos/administer/organizations/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization.md @@ -15,6 +15,7 @@ redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-github-copilot-activity-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/reviewing-usage-data-for-github-copilot-in-your-organization - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization --- ## Reviewing user activity data for {% data variables.product.prodname_copilot_short %} diff --git a/content/copilot/using-github-copilot/code-review/configuring-automatic-code-review-by-copilot.md b/content/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot.md similarity index 96% rename from content/copilot/using-github-copilot/code-review/configuring-automatic-code-review-by-copilot.md rename to content/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot.md index fae13b756e2d..32d26657e103 100644 --- a/content/copilot/using-github-copilot/code-review/configuring-automatic-code-review-by-copilot.md +++ b/content/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot.md @@ -1,11 +1,13 @@ --- title: Configuring automatic code review by Copilot shortTitle: Automatic code review -intro: "Learn how to configure {% data variables.product.prodname_copilot_short %} to automatically review pull requests." +intro: 'Learn how to configure {% data variables.product.prodname_copilot_short %} to automatically review pull requests.' versions: feature: copilot topics: - Copilot +redirect_from: + - /copilot/using-github-copilot/code-review/configuring-automatic-code-review-by-copilot --- ## About automatic code review diff --git a/content/copilot/using-github-copilot/code-review/configuring-coding-guidelines.md b/content/copilot/how-tos/agents/copilot-code-review/configuring-coding-guidelines.md similarity index 96% rename from content/copilot/using-github-copilot/code-review/configuring-coding-guidelines.md rename to content/copilot/how-tos/agents/copilot-code-review/configuring-coding-guidelines.md index 78d11315b548..8c6b61953a08 100644 --- a/content/copilot/using-github-copilot/code-review/configuring-coding-guidelines.md +++ b/content/copilot/how-tos/agents/copilot-code-review/configuring-coding-guidelines.md @@ -1,7 +1,7 @@ --- title: Configuring coding guidelines for GitHub Copilot code review shortTitle: Configure coding guidelines -intro: "Learn how to customize {% data variables.copilot.copilot_code-review_short %} with custom coding guidelines." +intro: 'Learn how to customize {% data variables.copilot.copilot_code-review_short %} with custom coding guidelines.' allowTitleToDifferFromFilename: true versions: feature: copilot @@ -10,6 +10,7 @@ topics: redirect_from: - /early-access/copilot/code-review/configuring-coding-guidelines - /early-access/copilot/code-reviews/configuring-coding-guidelines + - /copilot/using-github-copilot/code-review/configuring-coding-guidelines --- {% data reusables.copilot.code-review.custom-coding-guidelines-prerequisites %} diff --git a/content/copilot/using-github-copilot/code-review/index.md b/content/copilot/how-tos/agents/copilot-code-review/index.md similarity index 58% rename from content/copilot/using-github-copilot/code-review/index.md rename to content/copilot/how-tos/agents/copilot-code-review/index.md index 87c589148ae0..b422407a02d8 100644 --- a/content/copilot/using-github-copilot/code-review/index.md +++ b/content/copilot/how-tos/agents/copilot-code-review/index.md @@ -1,7 +1,7 @@ --- title: Code review shortTitle: Code review -intro: "Learn how to request a code review from {% data variables.product.prodname_copilot %}." +intro: 'Learn how to request a code review from {% data variables.product.prodname_copilot %}.' versions: feature: copilot topics: @@ -10,4 +10,7 @@ children: - /using-copilot-code-review - /configuring-coding-guidelines - /configuring-automatic-code-review-by-copilot +redirect_from: + - /copilot/using-github-copilot/code-review --- + diff --git a/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md b/content/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review.md similarity index 99% rename from content/copilot/using-github-copilot/code-review/using-copilot-code-review.md rename to content/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review.md index 6360e418aa43..a49aee634bf3 100644 --- a/content/copilot/using-github-copilot/code-review/using-copilot-code-review.md +++ b/content/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review.md @@ -1,7 +1,7 @@ --- title: Using GitHub Copilot code review shortTitle: Use code review -intro: "Learn how to request a code review from {% data variables.product.prodname_copilot %}." +intro: 'Learn how to request a code review from {% data variables.product.prodname_copilot %}.' allowTitleToDifferFromFilename: true versions: feature: copilot @@ -11,6 +11,7 @@ redirect_from: - /early-access/copilot/code-review/using-copilot-code-review - /early-access/copilot/code-reviews/using-copilot-code-review - /early-access/copilot/code-reviews/using-copilot-code-reviews + - /copilot/using-github-copilot/code-review/using-copilot-code-review --- ## About {% data variables.copilot.copilot_code-review_short %} diff --git a/content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md b/content/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request.md similarity index 97% rename from content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md rename to content/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request.md index e406cd5d4872..f3e095eb0df3 100644 --- a/content/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request.md @@ -11,6 +11,7 @@ type: how_to redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/asking-copilot-to-create-a-pull-request - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/asking-copilot-to-create-a-pull-request + - /copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request --- > [!NOTE] diff --git a/content/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md b/content/copilot/how-tos/agents/copilot-coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md similarity index 98% rename from content/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md rename to content/copilot/how-tos/agents/copilot-coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md index 93db42cc6a3a..9b8eeefdb6e3 100644 --- a/content/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/best-practices-for-using-copilot-to-work-on-tasks.md @@ -13,6 +13,7 @@ redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/best-practices-for-using-copilot-to-work-on-issues - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/best-practices-for-using-copilot-to-work-on-tasks - /early-access/copilot/coding-agent/best-practices-for-using-copilot-coding-agent + - /copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks --- {% data reusables.copilot.coding-agent.preview-note %} diff --git a/content/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md b/content/copilot/how-tos/agents/copilot-coding-agent/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md similarity index 94% rename from content/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md rename to content/copilot/how-tos/agents/copilot-coding-agent/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md index 676af2153218..85b61c963b2b 100644 --- a/content/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md @@ -1,12 +1,14 @@ --- title: Customizing or disabling the firewall for Copilot coding agent shortTitle: Customize the agent firewall -intro: "Learn how to control the domains and URLs that {% data variables.copilot.copilot_coding_agent %} can access." +intro: 'Learn how to control the domains and URLs that {% data variables.copilot.copilot_coding_agent %} can access.' versions: feature: copilot topics: - Copilot type: how_to +redirect_from: + - /copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent --- > [!NOTE] diff --git a/content/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent.md b/content/copilot/how-tos/agents/copilot-coding-agent/customizing-the-development-environment-for-copilot-coding-agent.md similarity index 97% rename from content/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent.md rename to content/copilot/how-tos/agents/copilot-coding-agent/customizing-the-development-environment-for-copilot-coding-agent.md index a1c3c92bfc47..e7beacca1d9a 100644 --- a/content/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/customizing-the-development-environment-for-copilot-coding-agent.md @@ -1,7 +1,7 @@ --- title: Customizing the development environment for Copilot coding agent shortTitle: Customize the agent environment -intro: "Learn how to customize {% data variables.product.prodname_copilot %}'s development environment with additional tools." +intro: 'Learn how to customize {% data variables.product.prodname_copilot %}''s development environment with additional tools.' versions: feature: copilot topics: @@ -9,6 +9,7 @@ topics: type: how_to redirect_from: - /early-access/copilot/coding-agent/customizing-copilot-coding-agents-development-environment + - /copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent --- > [!NOTE] diff --git a/content/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent.md b/content/copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent.md similarity index 98% rename from content/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent.md rename to content/copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent.md index d1a5b9da56e8..0eb85e9f5b86 100644 --- a/content/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent.md @@ -11,6 +11,7 @@ redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/enabling-copilot-coding-agent-for-your-personal-repositories - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent-for-your-personal-repositories + - /copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent --- {% data reusables.copilot.coding-agent.preview-note %} diff --git a/content/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp.md b/content/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp.md similarity index 99% rename from content/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp.md rename to content/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp.md index 4aeeeddee2e2..75e6a6a3525e 100644 --- a/content/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp.md @@ -2,7 +2,7 @@ title: Extending Copilot coding agent with the Model Context Protocol (MCP) shortTitle: Extend coding agent with MCP allowTitleToDifferFromFilename: true -intro: "Learn how to use the Model Context Protocol (MCP) to extend the capabilities of {% data variables.copilot.copilot_coding_agent %}." +intro: 'Learn how to use the Model Context Protocol (MCP) to extend the capabilities of {% data variables.copilot.copilot_coding_agent %}.' versions: feature: copilot topics: @@ -12,6 +12,7 @@ redirect_from: - /copilot/customizing-copilot/using-model-context-protocol/extending-copilot-coding-agent-with-mcp - /copilot/customizing-copilot/extending-copilot-coding-agent-with-mcp - /early-access/copilot/coding-agent/extending-copilot-coding-agent-with-model-context-protocol + - /copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp --- > [!NOTE] diff --git a/content/copilot/using-github-copilot/coding-agent/index.md b/content/copilot/how-tos/agents/copilot-coding-agent/index.md similarity index 81% rename from content/copilot/using-github-copilot/coding-agent/index.md rename to content/copilot/how-tos/agents/copilot-coding-agent/index.md index 9e14545e584a..4b29b9ae11b1 100644 --- a/content/copilot/using-github-copilot/coding-agent/index.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/index.md @@ -13,10 +13,13 @@ children: - /reviewing-a-pull-request-created-by-copilot - /using-the-copilot-coding-agent-logs - /extending-copilot-coding-agent-with-mcp + - /customizing-the-development-environment-for-copilot-coding-agent + - /customizing-or-disabling-the-firewall-for-copilot-coding-agent - /troubleshooting-copilot-coding-agent redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues - /early-access/copilot/coding-agent + - /copilot/using-github-copilot/coding-agent --- diff --git a/content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md b/content/copilot/how-tos/agents/copilot-coding-agent/reviewing-a-pull-request-created-by-copilot.md similarity index 98% rename from content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md rename to content/copilot/how-tos/agents/copilot-coding-agent/reviewing-a-pull-request-created-by-copilot.md index c875a4cb6938..0feb66ec2e7d 100644 --- a/content/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/reviewing-a-pull-request-created-by-copilot.md @@ -10,6 +10,7 @@ topics: type: how_to redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/reviewing-a-pull-request-created-by-copilot + - /copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot --- {% data reusables.copilot.coding-agent.preview-note %} diff --git a/content/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent.md b/content/copilot/how-tos/agents/copilot-coding-agent/troubleshooting-copilot-coding-agent.md similarity index 99% rename from content/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent.md rename to content/copilot/how-tos/agents/copilot-coding-agent/troubleshooting-copilot-coding-agent.md index 3aa92e1e30aa..927c49e5f36f 100644 --- a/content/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/troubleshooting-copilot-coding-agent.md @@ -12,6 +12,7 @@ redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/troubleshooting-copilot-coding-agent - /early-access/copilot/coding-agent/troubleshooting-copilot-coding-agent + - /copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent --- {% data reusables.copilot.coding-agent.preview-note %} diff --git a/content/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue.md b/content/copilot/how-tos/agents/copilot-coding-agent/using-copilot-to-work-on-an-issue.md similarity index 99% rename from content/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue.md rename to content/copilot/how-tos/agents/copilot-coding-agent/using-copilot-to-work-on-an-issue.md index 7fddd499b1ce..7e887e00f391 100644 --- a/content/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/using-copilot-to-work-on-an-issue.md @@ -11,6 +11,7 @@ redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-copilot-to-work-on-an-issue - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/using-copilot-to-work-on-an-issue - /early-access/copilot/coding-agent/using-copilot-coding-agent + - /copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue --- {% data reusables.copilot.coding-agent.preview-note %} diff --git a/content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md b/content/copilot/how-tos/agents/copilot-coding-agent/using-the-copilot-coding-agent-logs.md similarity index 95% rename from content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md rename to content/copilot/how-tos/agents/copilot-coding-agent/using-the-copilot-coding-agent-logs.md index b6604b7fa4ab..7f92200cf541 100644 --- a/content/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs.md +++ b/content/copilot/how-tos/agents/copilot-coding-agent/using-the-copilot-coding-agent-logs.md @@ -1,7 +1,7 @@ --- title: Using the Copilot coding agent logs shortTitle: Use the Copilot logs -intro: "You can use the session logs to understand {% data variables.product.prodname_copilot_short %}'s approach" +intro: "You can use the session logs to understand {% data variables.product.prodname_copilot_short %}'s approach." product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot @@ -10,6 +10,7 @@ topics: type: how_to redirect_from: - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs + - /copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs --- {% data reusables.copilot.coding-agent.preview-note %} diff --git a/content/copilot/how-tos/agents/index.md b/content/copilot/how-tos/agents/index.md new file mode 100644 index 000000000000..d0e622d50565 --- /dev/null +++ b/content/copilot/how-tos/agents/index.md @@ -0,0 +1,13 @@ +--- +title: Use GitHub Copilot agents +shortTitle: Agents +intro: 'Learn how to use {% data variables.product.prodname_copilot %} agents.' +versions: + feature: copilot +topics: + - Copilot +children: + - /copilot-coding-agent + - /copilot-code-review +--- + diff --git a/content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat.md b/content/copilot/how-tos/ai-models/changing-the-ai-model-for-copilot-chat.md similarity index 98% rename from content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat.md rename to content/copilot/how-tos/ai-models/changing-the-ai-model-for-copilot-chat.md index 5fb1fcdd222d..d55b53b80c23 100644 --- a/content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat.md +++ b/content/copilot/how-tos/ai-models/changing-the-ai-model-for-copilot-chat.md @@ -1,11 +1,13 @@ --- title: Changing the AI model for Copilot Chat -shortTitle: 'Change the chat model' +shortTitle: Change the chat model intro: 'Learn how to change the default LLM for {% data variables.copilot.copilot_chat_short %} to a different model.' versions: feature: copilot topics: - Copilot +redirect_from: + - /copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-chat --- By default, {% data variables.copilot.copilot_chat_short %} uses {% data variables.copilot.copilot_gpt_41 %} to provide fast, capable responses for a wide range of tasks, such as summarization, knowledge-based questions, reasoning, math, and coding. diff --git a/content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-code-completion.md b/content/copilot/how-tos/ai-models/changing-the-ai-model-for-copilot-code-completion.md similarity index 97% rename from content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-code-completion.md rename to content/copilot/how-tos/ai-models/changing-the-ai-model-for-copilot-code-completion.md index 5a6c4c268c0d..355b8d116346 100644 --- a/content/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-code-completion.md +++ b/content/copilot/how-tos/ai-models/changing-the-ai-model-for-copilot-code-completion.md @@ -1,11 +1,13 @@ --- title: Changing the AI model for Copilot code completion -shortTitle: 'Change the completion model' +shortTitle: Change the completion model intro: 'Learn how to change the default LLM for {% data variables.product.prodname_copilot_short %} code completion to a different model.' versions: feature: copilot topics: - Copilot +redirect_from: + - /copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-code-completion --- ## Overview diff --git a/content/copilot/using-github-copilot/ai-models/configuring-access-to-ai-models-in-copilot.md b/content/copilot/how-tos/ai-models/configuring-access-to-ai-models-in-copilot.md similarity index 96% rename from content/copilot/using-github-copilot/ai-models/configuring-access-to-ai-models-in-copilot.md rename to content/copilot/how-tos/ai-models/configuring-access-to-ai-models-in-copilot.md index 6edd99613279..03ccf674c3f4 100644 --- a/content/copilot/using-github-copilot/ai-models/configuring-access-to-ai-models-in-copilot.md +++ b/content/copilot/how-tos/ai-models/configuring-access-to-ai-models-in-copilot.md @@ -6,6 +6,8 @@ versions: feature: copilot topics: - Copilot +redirect_from: + - /copilot/using-github-copilot/ai-models/configuring-access-to-ai-models-in-copilot --- Your access to {% data variables.product.prodname_copilot %} models depends on: diff --git a/content/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot.md b/content/copilot/how-tos/ai-models/creating-a-custom-model-for-github-copilot.md similarity index 98% rename from content/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot.md rename to content/copilot/how-tos/ai-models/creating-a-custom-model-for-github-copilot.md index 972da647ac7c..f84454fd3f8e 100644 --- a/content/copilot/customizing-copilot/creating-a-custom-model-for-github-copilot.md +++ b/content/copilot/how-tos/ai-models/creating-a-custom-model-for-github-copilot.md @@ -1,8 +1,8 @@ --- title: Creating a custom model for GitHub Copilot shortTitle: Create a custom model -intro: "You can fine-tune {% data variables.product.prodname_copilot_short %} code completion by creating a custom model based on code in your organization's repositories." -permissions: "Owners of organizations enrolled in the {% data variables.release-phases.public_preview %}." +intro: 'You can fine-tune {% data variables.product.prodname_copilot_short %} code completion by creating a custom model based on code in your organization''s repositories.' +permissions: 'Owners of organizations enrolled in the {% data variables.release-phases.public_preview %}.' product: '{% data reusables.copilot.ce-product-callout %}' versions: feature: copilot-custom-models @@ -11,6 +11,7 @@ topics: redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/customizing-copilot-for-your-organization/creating-a-custom-model-for-github-copilot - /copilot/managing-copilot/managing-github-copilot-in-your-organization/enhancing-copilot-for-your-organization/creating-a-custom-model-for-github-copilot + - /copilot/customizing-copilot/creating-a-custom-model-for-github-copilot --- > [!NOTE] The current {% data variables.release-phases.public_preview %} of custom models for {% data variables.copilot.copilot_enterprise %} will be discontinued. For now, participants can continue using their custom models, but we are no longer processing new training requests. We encourage participants to try the newer {% data variables.copilot.copilot_gpt_4o %} {% data variables.product.prodname_copilot_short %} code completion model. See [Changing the AI model for Copilot code completion](/copilot/using-github-copilot/ai-models/changing-the-ai-model-for-copilot-code-completion?tool=vscode). diff --git a/content/copilot/using-github-copilot/ai-models/index.md b/content/copilot/how-tos/ai-models/index.md similarity index 77% rename from content/copilot/using-github-copilot/ai-models/index.md rename to content/copilot/how-tos/ai-models/index.md index 60f7397c7ee0..f50560267775 100644 --- a/content/copilot/using-github-copilot/ai-models/index.md +++ b/content/copilot/how-tos/ai-models/index.md @@ -10,5 +10,8 @@ children: - /configuring-access-to-ai-models-in-copilot - /changing-the-ai-model-for-copilot-chat - /changing-the-ai-model-for-copilot-code-completion + - /creating-a-custom-model-for-github-copilot +redirect_from: + - /copilot/using-github-copilot/ai-models --- diff --git a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github.md b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github.md similarity index 94% rename from content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github.md rename to content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github.md index a65ce2906b99..566afb88b9f5 100644 --- a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github.md +++ b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github.md @@ -7,6 +7,8 @@ topics: - Copilot shortTitle: Communicate with GitHub type: reference +redirect_from: + - /copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-github --- ## Prerequisites diff --git a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-the-copilot-platform.md b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-the-copilot-platform.md similarity index 97% rename from content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-the-copilot-platform.md rename to content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-the-copilot-platform.md index bfa1131b44cd..faecb510695a 100644 --- a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-the-copilot-platform.md +++ b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-the-copilot-platform.md @@ -8,6 +8,8 @@ topics: shortTitle: Communicate with Copilot platform type: reference layout: inline +redirect_from: + - /copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/configuring-your-copilot-agent-to-communicate-with-the-copilot-platform --- {% data variables.copilot.copilot_agents_short %} communicate with the {% data variables.product.prodname_copilot_short %} platform in the form of server-sent events (SSEs). Rather than waiting for the {% data variables.product.prodname_copilot_short %} platform to request an update from your agent, or vice versa, you can use SSEs to send and receive updates to and from the platform in real time. diff --git a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md similarity index 98% rename from content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md rename to content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md index c5f11e940dd2..81251e321e7f 100644 --- a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md +++ b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent.md @@ -7,6 +7,8 @@ topics: - Copilot shortTitle: Context passing type: how_to +redirect_from: + - /copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/context-passing-for-your-agent --- ## About context passing diff --git a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/index.md b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/index.md similarity index 83% rename from content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/index.md rename to content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/index.md index 27c6806106a3..6dd2c26a6b19 100644 --- a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/index.md +++ b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/index.md @@ -11,5 +11,7 @@ children: - /configuring-your-copilot-agent-to-communicate-with-github - /context-passing-for-your-agent - /using-copilots-llm-for-your-agent +redirect_from: + - /copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension --- diff --git a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-copilots-llm-for-your-agent.md b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-copilots-llm-for-your-agent.md similarity index 95% rename from content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-copilots-llm-for-your-agent.md rename to content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-copilots-llm-for-your-agent.md index a3371a296573..96471765199f 100644 --- a/content/copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-copilots-llm-for-your-agent.md +++ b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-copilots-llm-for-your-agent.md @@ -8,6 +8,8 @@ topics: shortTitle: Use Copilot's LLM type: reference allowTitleToDifferFromFilename: true +redirect_from: + - /copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-copilots-llm-for-your-agent --- ## About {% data variables.product.prodname_copilot_short %}'s Large Language Model (LLM) diff --git a/content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md similarity index 95% rename from content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md rename to content/copilot/how-tos/build-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md index 8286883b082f..a8f19769347a 100644 --- a/content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md +++ b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets.md @@ -5,8 +5,10 @@ versions: feature: copilot-extensions topics: - Copilot -shortTitle: Build {% data variables.copilot.copilot_skillsets_short %} +shortTitle: 'Build {% data variables.copilot.copilot_skillsets_short %}' type: how_to +redirect_from: + - /copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/building-copilot-skillsets --- ## Introduction diff --git a/content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/index.md b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/index.md similarity index 78% rename from content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/index.md rename to content/copilot/how-tos/build-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/index.md index 2935617a160a..5c0816eee42c 100644 --- a/content/copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/index.md +++ b/content/copilot/how-tos/build-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension/index.md @@ -8,5 +8,7 @@ topics: - Copilot children: - /building-copilot-skillsets +redirect_from: + - /copilot/building-copilot-extensions/building-a-copilot-skillset-for-your-copilot-extension --- diff --git a/content/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension.md b/content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension.md similarity index 98% rename from content/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension.md rename to content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension.md index 6dc1cb1a3e63..c2b6bb2d4ec6 100644 --- a/content/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension.md +++ b/content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension.md @@ -10,6 +10,7 @@ shortTitle: Configure App for extension type: how_to redirect_from: - /copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-agent + - /copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-github-app-for-your-copilot-extension --- Once you have configured your server and created your {% data variables.product.prodname_github_app %}, you need to configure your {% data variables.product.prodname_github_app %} for use with your {% data variables.product.prodname_copilot_short %} extension. diff --git a/content/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-extension.md b/content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-extension.md similarity index 95% rename from content/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-extension.md rename to content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-extension.md index 6d345c9d1c6f..b6e2f070b3d1 100644 --- a/content/copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-extension.md +++ b/content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-extension.md @@ -6,6 +6,7 @@ versions: redirect_from: - /copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-deploy-your-copilot-agent - /copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-agent + - /copilot/building-copilot-extensions/creating-a-copilot-extension/configuring-your-server-to-host-your-copilot-extension topics: - Copilot shortTitle: Host your extension diff --git a/content/copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension.md b/content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension.md similarity index 95% rename from content/copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension.md rename to content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension.md index cf0e37f9f363..b8ff771076db 100644 --- a/content/copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension.md +++ b/content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension.md @@ -7,6 +7,8 @@ topics: - Copilot shortTitle: Create GitHub App type: how_to +redirect_from: + - /copilot/building-copilot-extensions/creating-a-copilot-extension/creating-a-github-app-for-your-copilot-extension --- A {% data variables.copilot.copilot_extension_short %} is a {% data variables.product.prodname_github_app %} that is associated with a {% data variables.copilot.copilot_agent_short %}. The {% data variables.product.prodname_github_app %} you associate your {% data variables.copilot.copilot_agent_short %} with is used to authenticate the {% data variables.copilot.copilot_agent_short %} with {% data variables.product.prodname_dotcom %} and to authorize the {% data variables.copilot.copilot_agent_short %} to access the {% data variables.copilot.copilot_chat_short %} API. Each {% data variables.copilot.copilot_agent_short %} must be associated with a unique {% data variables.product.prodname_github_app %}. diff --git a/content/copilot/building-copilot-extensions/creating-a-copilot-extension/index.md b/content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/index.md similarity index 86% rename from content/copilot/building-copilot-extensions/creating-a-copilot-extension/index.md rename to content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/index.md index 91eb74fc4a09..8efe4853e69a 100644 --- a/content/copilot/building-copilot-extensions/creating-a-copilot-extension/index.md +++ b/content/copilot/how-tos/build-copilot-extensions/creating-a-copilot-extension/index.md @@ -10,5 +10,7 @@ children: - /configuring-your-server-to-host-your-copilot-extension - /creating-a-github-app-for-your-copilot-extension - /configuring-your-github-app-for-your-copilot-extension +redirect_from: + - /copilot/building-copilot-extensions/creating-a-copilot-extension --- diff --git a/content/copilot/building-copilot-extensions/debugging-your-github-copilot-extension.md b/content/copilot/how-tos/build-copilot-extensions/debugging-your-github-copilot-extension.md similarity index 97% rename from content/copilot/building-copilot-extensions/debugging-your-github-copilot-extension.md rename to content/copilot/how-tos/build-copilot-extensions/debugging-your-github-copilot-extension.md index 10f0e06e0df5..f315f38776b1 100644 --- a/content/copilot/building-copilot-extensions/debugging-your-github-copilot-extension.md +++ b/content/copilot/how-tos/build-copilot-extensions/debugging-your-github-copilot-extension.md @@ -6,6 +6,8 @@ versions: topics: - Copilot shortTitle: Debug Copilot Extension +redirect_from: + - /copilot/building-copilot-extensions/debugging-your-github-copilot-extension --- With the debug tool for {% data variables.copilot.copilot_extensions_short %}, you can chat with your {% data variables.copilot.copilot_agent_short %} from the command line, then view detailed logs as your agent generates a response. You can pass several flags to the tool, with the most important flags being: diff --git a/content/copilot/building-copilot-extensions/index.md b/content/copilot/how-tos/build-copilot-extensions/index.md similarity index 83% rename from content/copilot/building-copilot-extensions/index.md rename to content/copilot/how-tos/build-copilot-extensions/index.md index 5d6630c03f73..5ac579790c4d 100644 --- a/content/copilot/building-copilot-extensions/index.md +++ b/content/copilot/how-tos/build-copilot-extensions/index.md @@ -1,6 +1,6 @@ --- -title: Building Copilot Extensions -shortTitle: Build Copilot Extensions +title: Copilot Extensions +shortTitle: Copilot Extensions intro: 'Learn how to integrate external tools with {% data variables.product.prodname_copilot_short %}.' versions: feature: copilot @@ -15,5 +15,7 @@ children: - /using-oidc-with-github-copilot-extensions - /debugging-your-github-copilot-extension - /managing-the-availability-of-your-copilot-extension +redirect_from: + - /copilot/building-copilot-extensions --- diff --git a/content/copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension.md b/content/copilot/how-tos/build-copilot-extensions/managing-the-availability-of-your-copilot-extension.md similarity index 98% rename from content/copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension.md rename to content/copilot/how-tos/build-copilot-extensions/managing-the-availability-of-your-copilot-extension.md index 911b2b9de5bc..4acf26a12042 100644 --- a/content/copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension.md +++ b/content/copilot/how-tos/build-copilot-extensions/managing-the-availability-of-your-copilot-extension.md @@ -7,6 +7,8 @@ topics: - Copilot shortTitle: Manage Extension availability type: how_to +redirect_from: + - /copilot/building-copilot-extensions/managing-the-availability-of-your-copilot-extension --- When you build a {% data variables.copilot.copilot_extension_short %}, you have two options for the visibility of your {% data variables.product.prodname_github_app %}: diff --git a/content/copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents.md b/content/copilot/how-tos/build-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents.md similarity index 99% rename from content/copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents.md rename to content/copilot/how-tos/build-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents.md index 7ae975162cf2..1b8d5f658ec6 100644 --- a/content/copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents.md +++ b/content/copilot/how-tos/build-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents.md @@ -7,6 +7,7 @@ versions: redirect_from: - /copilot/building-copilot-extensions/building-a-copilot-agent-for-your-copilot-extension/using-a-demo-agent - /copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions + - /copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents topics: - Copilot shortTitle: Extensions quickstart diff --git a/content/copilot/building-copilot-extensions/setting-up-copilot-extensions.md b/content/copilot/how-tos/build-copilot-extensions/setting-up-copilot-extensions.md similarity index 99% rename from content/copilot/building-copilot-extensions/setting-up-copilot-extensions.md rename to content/copilot/how-tos/build-copilot-extensions/setting-up-copilot-extensions.md index a059db93647d..944dad01301c 100644 --- a/content/copilot/building-copilot-extensions/setting-up-copilot-extensions.md +++ b/content/copilot/how-tos/build-copilot-extensions/setting-up-copilot-extensions.md @@ -7,6 +7,8 @@ versions: topics: - Copilot shortTitle: Set up Copilot Extensions +redirect_from: + - /copilot/building-copilot-extensions/setting-up-copilot-extensions --- This article is designed to help you build an entirely new {% data variables.copilot.copilot_extension %}. To instead learn how to quickly build and test a demo {% data variables.copilot.copilot_extension_short %} created by {% data variables.product.github %}, see [AUTOTITLE](/copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions). diff --git a/content/copilot/building-copilot-extensions/using-oidc-with-github-copilot-extensions.md b/content/copilot/how-tos/build-copilot-extensions/using-oidc-with-github-copilot-extensions.md similarity index 97% rename from content/copilot/building-copilot-extensions/using-oidc-with-github-copilot-extensions.md rename to content/copilot/how-tos/build-copilot-extensions/using-oidc-with-github-copilot-extensions.md index 6b54f5d7146e..914019175aaf 100644 --- a/content/copilot/building-copilot-extensions/using-oidc-with-github-copilot-extensions.md +++ b/content/copilot/how-tos/build-copilot-extensions/using-oidc-with-github-copilot-extensions.md @@ -1,8 +1,6 @@ --- title: Using OIDC with GitHub Copilot Extensions -intro: >- - Learn how to use OpenID Connect (OIDC) with your {% data - variables.copilot.copilot_extension_short %} to enhance security. +intro: 'Learn how to use OpenID Connect (OIDC) with your {% data variables.copilot.copilot_extension_short %} to enhance security.' versions: feature: copilot-extensions topics: @@ -11,6 +9,7 @@ shortTitle: Use OIDC type: how_to redirect_from: - /copilot/building-copilot-extensions/using-oidc-with-copilot-extensions + - /copilot/building-copilot-extensions/using-oidc-with-github-copilot-extensions --- ## About OpenID Connect (OIDC) for {% data variables.copilot.copilot_extensions_short %} diff --git a/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github-mobile.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github-mobile.md similarity index 99% rename from content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github-mobile.md rename to content/copilot/how-tos/chat/asking-github-copilot-questions-in-github-mobile.md index f2c693087996..c0f1cd231861 100644 --- a/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github-mobile.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github-mobile.md @@ -12,6 +12,7 @@ redirect_from: - /copilot/github-copilot-chat/copilot-chat-in-github-mobile/using-github-copilot-chat-in-github-mobile - /copilot/github-copilot-chat/copilot-chat-in-github-mobile - /copilot/using-github-copilot/asking-github-copilot-questions-in-github-mobile + - /copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github-mobile --- ## Overview diff --git a/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md similarity index 99% rename from content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github.md rename to content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md index 9b794d1a4da1..69a5c2deda53 100644 --- a/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-github.md @@ -14,6 +14,7 @@ redirect_from: - /copilot/github-copilot-chat/copilot-chat-in-github - /copilot/using-github-copilot/asking-github-copilot-questions-in-githubcom - /copilot/using-github-copilot/asking-github-copilot-questions-in-github + - /copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github --- ## Overview diff --git a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-windows-terminal.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-windows-terminal.md similarity index 95% rename from content/copilot/using-github-copilot/asking-github-copilot-questions-in-windows-terminal.md rename to content/copilot/how-tos/chat/asking-github-copilot-questions-in-windows-terminal.md index 18ef3afc181c..35be0659ed29 100644 --- a/content/copilot/using-github-copilot/asking-github-copilot-questions-in-windows-terminal.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-windows-terminal.md @@ -6,6 +6,8 @@ topics: shortTitle: Copilot in Windows Terminal versions: feature: copilot +redirect_from: + - /copilot/using-github-copilot/asking-github-copilot-questions-in-windows-terminal --- ## Prerequisites diff --git a/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide.md b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md similarity index 99% rename from content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide.md rename to content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md index 9180d095ce78..20e884c305b0 100644 --- a/content/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide.md +++ b/content/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide.md @@ -9,6 +9,7 @@ redirect_from: - /copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide - /copilot/github-copilot-chat/copilot-chat-in-ides - /copilot/using-github-copilot/asking-github-copilot-questions-in-your-ide + - /copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide defaultTool: vscode versions: feature: copilot diff --git a/content/copilot/using-github-copilot/copilot-chat/index.md b/content/copilot/how-tos/chat/index.md similarity index 78% rename from content/copilot/using-github-copilot/copilot-chat/index.md rename to content/copilot/how-tos/chat/index.md index 200cf6daff5d..d6ddf3944231 100644 --- a/content/copilot/using-github-copilot/copilot-chat/index.md +++ b/content/copilot/how-tos/chat/index.md @@ -1,5 +1,6 @@ --- title: Copilot Chat +shortTitle: Chat intro: 'Learn how to use {% data variables.copilot.copilot_chat_short %} across different environments.' versions: feature: copilot @@ -7,8 +8,10 @@ topics: - Copilot redirect_from: - /copilot/github-copilot-enterprise/copilot-chat-in-github/about-github-copilot-chat + - /copilot/using-github-copilot/copilot-chat children: - /asking-github-copilot-questions-in-your-ide + - /asking-github-copilot-questions-in-windows-terminal - /asking-github-copilot-questions-in-github - /asking-github-copilot-questions-in-github-mobile --- diff --git a/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md b/content/copilot/how-tos/completions/finding-public-code-that-matches-github-copilot-suggestions.md similarity index 99% rename from content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md rename to content/copilot/how-tos/completions/finding-public-code-that-matches-github-copilot-suggestions.md index 619ac1d1d646..42cac82db94c 100644 --- a/content/copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions.md +++ b/content/copilot/how-tos/completions/finding-public-code-that-matches-github-copilot-suggestions.md @@ -5,6 +5,7 @@ intro: 'If you allow {% data variables.product.prodname_copilot %} to make sugge defaultTool: vscode redirect_from: - /early-access/copilot/code-referencing-in-github-copilot + - /copilot/using-github-copilot/finding-public-code-that-matches-github-copilot-suggestions topics: - Copilot versions: diff --git a/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md b/content/copilot/how-tos/completions/getting-code-suggestions-in-your-ide-with-github-copilot.md similarity index 99% rename from content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md rename to content/copilot/how-tos/completions/getting-code-suggestions-in-your-ide-with-github-copilot.md index 8d16d3716399..32debf103f83 100644 --- a/content/copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot.md +++ b/content/copilot/how-tos/completions/getting-code-suggestions-in-your-ide-with-github-copilot.md @@ -4,6 +4,7 @@ shortTitle: Get code suggestions intro: 'Use {% data variables.product.prodname_copilot %} to get code suggestions in your editor.' redirect_from: - /copilot/using-github-copilot/using-github-copilot-code-suggestions-in-your-editor + - /copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot versions: feature: copilot defaultTool: vscode diff --git a/content/copilot/how-tos/completions/index.md b/content/copilot/how-tos/completions/index.md new file mode 100644 index 000000000000..bef6408d4d2c --- /dev/null +++ b/content/copilot/how-tos/completions/index.md @@ -0,0 +1,14 @@ +--- +title: Get suggestions from GitHub Copilot +shortTitle: Completions +intro: 'Learn how to use {% data variables.product.prodname_copilot %}.' +versions: + feature: copilot +topics: + - Copilot +children: + - /getting-code-suggestions-in-your-ide-with-github-copilot + - /using-copilot-text-completion + - /finding-public-code-that-matches-github-copilot-suggestions +--- + diff --git a/content/copilot/using-github-copilot/using-copilot-text-completion.md b/content/copilot/how-tos/completions/using-copilot-text-completion.md similarity index 97% rename from content/copilot/using-github-copilot/using-copilot-text-completion.md rename to content/copilot/how-tos/completions/using-copilot-text-completion.md index 9250b5be2a83..bdff2dd1dc9f 100644 --- a/content/copilot/using-github-copilot/using-copilot-text-completion.md +++ b/content/copilot/how-tos/completions/using-copilot-text-completion.md @@ -7,6 +7,8 @@ versions: permissions: 'Members of an enterprise with a subscription to [{% data variables.copilot.copilot_enterprise %}](/copilot/github-copilot-enterprise/overview/about-github-copilot-enterprise)' topics: - Copilot +redirect_from: + - /copilot/using-github-copilot/using-copilot-text-completion --- >[!NOTE] diff --git a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md b/content/copilot/how-tos/content-exclusion/excluding-content-from-github-copilot.md similarity index 99% rename from content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md rename to content/copilot/how-tos/content-exclusion/excluding-content-from-github-copilot.md index e9aeec08cacd..7ec1dd1fdc88 100644 --- a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot.md +++ b/content/copilot/how-tos/content-exclusion/excluding-content-from-github-copilot.md @@ -18,6 +18,7 @@ redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/testing-changes-to-content-exclusions-in-your-ide - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/configuring-content-exclusions-for-github-copilot - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/testing-changes-to-content-exclusions-in-your-ide + - /copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot topics: - Copilot --- diff --git a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/index.md b/content/copilot/how-tos/content-exclusion/index.md similarity index 66% rename from content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/index.md rename to content/copilot/how-tos/content-exclusion/index.md index b5a610725698..679f6990438f 100644 --- a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/index.md +++ b/content/copilot/how-tos/content-exclusion/index.md @@ -1,6 +1,6 @@ --- -title: Configuring and auditing content exclusion -shortTitle: Configure content exclusion +title: Configure and audit content exclusion +shortTitle: Content exclusion intro: 'You can prevent {% data variables.product.prodname_copilot_short %} from accessing certain content, and review any changes to these settings.' versions: feature: copilot @@ -9,4 +9,7 @@ topics: children: - /excluding-content-from-github-copilot - /reviewing-changes-to-content-exclusions-for-github-copilot +redirect_from: + - /copilot/managing-copilot/configuring-and-auditing-content-exclusion --- + diff --git a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md b/content/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md similarity index 96% rename from content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md rename to content/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md index 7260698f96ca..0df64af19113 100644 --- a/content/copilot/managing-copilot/configuring-and-auditing-content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md +++ b/content/copilot/how-tos/content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot.md @@ -13,6 +13,7 @@ redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/reviewing-changes-to-content-exclusions-for-github-copilot - /copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/reviewing-changes-to-content-exclusions-for-github-copilot - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/reviewing-changes-to-content-exclusions-for-github-copilot + - /copilot/managing-copilot/configuring-and-auditing-content-exclusion/reviewing-changes-to-content-exclusions-for-github-copilot --- Organization and repository settings include the ability to exclude content from being used by {% data variables.product.prodname_copilot %}. You can review any changes that are made to these content exclusion settings. diff --git a/content/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces.md b/content/copilot/how-tos/context/copilot-spaces/collaborating-with-your-team-using-copilot-spaces.md similarity index 96% rename from content/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces.md rename to content/copilot/how-tos/context/copilot-spaces/collaborating-with-your-team-using-copilot-spaces.md index 606c9188d255..5d8999a06d47 100644 --- a/content/copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces.md +++ b/content/copilot/how-tos/context/copilot-spaces/collaborating-with-your-team-using-copilot-spaces.md @@ -8,6 +8,8 @@ versions: type: how_to topics: - Copilot +redirect_from: + - /copilot/using-github-copilot/copilot-spaces/collaborating-with-your-team-using-copilot-spaces --- {% data reusables.copilot.copilot-spaces.preview-note %} diff --git a/content/copilot/using-github-copilot/copilot-spaces/creating-and-using-copilot-spaces.md b/content/copilot/how-tos/context/copilot-spaces/creating-and-using-copilot-spaces.md similarity index 97% rename from content/copilot/using-github-copilot/copilot-spaces/creating-and-using-copilot-spaces.md rename to content/copilot/how-tos/context/copilot-spaces/creating-and-using-copilot-spaces.md index 38025c6b70a8..2986b1956075 100644 --- a/content/copilot/using-github-copilot/copilot-spaces/creating-and-using-copilot-spaces.md +++ b/content/copilot/how-tos/context/copilot-spaces/creating-and-using-copilot-spaces.md @@ -8,6 +8,8 @@ versions: type: how_to topics: - Copilot +redirect_from: + - /copilot/using-github-copilot/copilot-spaces/creating-and-using-copilot-spaces --- {% data reusables.copilot.copilot-spaces.preview-note %} diff --git a/content/copilot/using-github-copilot/copilot-spaces/index.md b/content/copilot/how-tos/context/copilot-spaces/index.md similarity index 86% rename from content/copilot/using-github-copilot/copilot-spaces/index.md rename to content/copilot/how-tos/context/copilot-spaces/index.md index f822637359ea..463bce8a2551 100644 --- a/content/copilot/using-github-copilot/copilot-spaces/index.md +++ b/content/copilot/how-tos/context/copilot-spaces/index.md @@ -8,5 +8,7 @@ topics: children: - /creating-and-using-copilot-spaces - /collaborating-with-your-team-using-copilot-spaces +redirect_from: + - /copilot/using-github-copilot/copilot-spaces --- diff --git a/content/copilot/how-tos/context/index.md b/content/copilot/how-tos/context/index.md new file mode 100644 index 000000000000..a7210075b475 --- /dev/null +++ b/content/copilot/how-tos/context/index.md @@ -0,0 +1,17 @@ +--- +title: Provide context to GitHub Copilot +shortTitle: Context +intro: 'Learn how to give {% data variables.product.prodname_copilot %} relevant information to increase the quality of responses.' +versions: + feature: copilot +topics: + - Copilot +children: + - /copilot-spaces + - /model-context-protocol + - /managing-copilot-knowledge-bases + - /install-copilot-extensions +redirect_from: + - /copilot/customizing-copilot +--- + diff --git a/content/copilot/customizing-copilot/extending-the-capabilities-of-github-copilot-in-your-organization.md b/content/copilot/how-tos/context/install-copilot-extensions/extending-the-capabilities-of-github-copilot-in-your-organization.md similarity index 97% rename from content/copilot/customizing-copilot/extending-the-capabilities-of-github-copilot-in-your-organization.md rename to content/copilot/how-tos/context/install-copilot-extensions/extending-the-capabilities-of-github-copilot-in-your-organization.md index 9f8cc55ceb3a..0d3258623797 100644 --- a/content/copilot/customizing-copilot/extending-the-capabilities-of-github-copilot-in-your-organization.md +++ b/content/copilot/how-tos/context/install-copilot-extensions/extending-the-capabilities-of-github-copilot-in-your-organization.md @@ -14,6 +14,7 @@ redirect_from: - /copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-organization - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/installing-github-copilot-extensions-for-your-organization - /copilot/managing-copilot/managing-github-copilot-in-your-organization/enhancing-copilot-for-your-organization/installing-github-copilot-extensions-for-your-organization + - /copilot/customizing-copilot/extending-the-capabilities-of-github-copilot-in-your-organization --- ## About {% data variables.copilot.copilot_extensions %} for your organization diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/extending-the-capabilities-of-github-copilot-in-your-personal-account.md b/content/copilot/how-tos/context/install-copilot-extensions/extending-the-capabilities-of-github-copilot-in-your-personal-account.md similarity index 95% rename from content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/extending-the-capabilities-of-github-copilot-in-your-personal-account.md rename to content/copilot/how-tos/context/install-copilot-extensions/extending-the-capabilities-of-github-copilot-in-your-personal-account.md index e8b6484f3425..db3301d0db52 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/extending-the-capabilities-of-github-copilot-in-your-personal-account.md +++ b/content/copilot/how-tos/context/install-copilot-extensions/extending-the-capabilities-of-github-copilot-in-your-personal-account.md @@ -11,6 +11,7 @@ redirect_from: - /copilot/github-copilot-chat/github-copilot-extensions/installing-github-copilot-extensions-for-your-personal-account - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/installing-github-copilot-extensions-for-your-personal-account - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/extending-the-capabilities-of-github-copilot-in-your-personal-account + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/extending-the-capabilities-of-github-copilot-in-your-personal-account --- ## About {% data variables.copilot.copilot_extensions %} for your personal account diff --git a/content/copilot/how-tos/context/install-copilot-extensions/index.md b/content/copilot/how-tos/context/install-copilot-extensions/index.md new file mode 100644 index 000000000000..0f67bf28badb --- /dev/null +++ b/content/copilot/how-tos/context/install-copilot-extensions/index.md @@ -0,0 +1,14 @@ +--- +title: Install GitHub Copilot Extensions +shortTitle: Install Copilot Extensions +intro: 'You can interact with external tools and add additional functionality to {% data variables.product.prodname_copilot_short %}.' +versions: + feature: copilot +topics: + - Copilot +children: + - /using-extensions-to-integrate-external-tools-with-copilot-chat + - /extending-the-capabilities-of-github-copilot-in-your-personal-account + - /extending-the-capabilities-of-github-copilot-in-your-organization +--- + diff --git a/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md b/content/copilot/how-tos/context/install-copilot-extensions/using-extensions-to-integrate-external-tools-with-copilot-chat.md similarity index 99% rename from content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md rename to content/copilot/how-tos/context/install-copilot-extensions/using-extensions-to-integrate-external-tools-with-copilot-chat.md index 54e649f38612..97883847989c 100644 --- a/content/copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat.md +++ b/content/copilot/how-tos/context/install-copilot-extensions/using-extensions-to-integrate-external-tools-with-copilot-chat.md @@ -12,6 +12,7 @@ redirect_from: - /copilot/github-copilot-chat/github-copilot-extensions/about-github-copilot-extensions - /copilot/github-copilot-chat/github-copilot-extensions/using-github-copilot-extensions - /copilot/github-copilot-chat/github-copilot-extensions + - /copilot/using-github-copilot/using-extensions-to-integrate-external-tools-with-copilot-chat --- ## About {% data variables.copilot.copilot_extensions %} diff --git a/content/copilot/customizing-copilot/managing-copilot-knowledge-bases.md b/content/copilot/how-tos/context/managing-copilot-knowledge-bases.md similarity index 99% rename from content/copilot/customizing-copilot/managing-copilot-knowledge-bases.md rename to content/copilot/how-tos/context/managing-copilot-knowledge-bases.md index 76640c7fe257..e5f04df2caf0 100644 --- a/content/copilot/customizing-copilot/managing-copilot-knowledge-bases.md +++ b/content/copilot/how-tos/context/managing-copilot-knowledge-bases.md @@ -18,6 +18,7 @@ redirect_from: - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-copilot-knowledge-bases - /copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-github-copilot-features-in-your-organization/managing-copilot-knowledge-bases - /copilot/github-copilot-enterprise/copilot-docset-management/about-copilot-docset-management + - /copilot/customizing-copilot/managing-copilot-knowledge-bases --- > [!TIP] If you're looking for a more flexible way to organize context for {% data variables.product.prodname_copilot_short %}, you can also try {% data variables.copilot.copilot_spaces %}. diff --git a/content/copilot/customizing-copilot/using-model-context-protocol/extending-copilot-chat-with-mcp.md b/content/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp.md similarity index 98% rename from content/copilot/customizing-copilot/using-model-context-protocol/extending-copilot-chat-with-mcp.md rename to content/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp.md index 3e40f0a72f26..4e9f19490c51 100644 --- a/content/copilot/customizing-copilot/using-model-context-protocol/extending-copilot-chat-with-mcp.md +++ b/content/copilot/how-tos/context/model-context-protocol/extending-copilot-chat-with-mcp.md @@ -2,7 +2,7 @@ title: Extending Copilot Chat with the Model Context Protocol (MCP) allowTitleToDifferFromFilename: true shortTitle: Extend Copilot Chat with MCP -intro: "Learn how to use the Model Context Protocol (MCP) to extend {% data variables.copilot.copilot_chat_short %}." +intro: 'Learn how to use the Model Context Protocol (MCP) to extend {% data variables.copilot.copilot_chat_short %}.' versions: feature: copilot topics: @@ -10,6 +10,7 @@ topics: type: how_to redirect_from: - /copilot/customizing-copilot/extending-copilot-chat-with-mcp + - /copilot/customizing-copilot/using-model-context-protocol/extending-copilot-chat-with-mcp --- >[!NOTE] diff --git a/content/copilot/customizing-copilot/using-model-context-protocol/index.md b/content/copilot/how-tos/context/model-context-protocol/index.md similarity index 82% rename from content/copilot/customizing-copilot/using-model-context-protocol/index.md rename to content/copilot/how-tos/context/model-context-protocol/index.md index 4112b8b935bc..8aee22afd48b 100644 --- a/content/copilot/customizing-copilot/using-model-context-protocol/index.md +++ b/content/copilot/how-tos/context/model-context-protocol/index.md @@ -9,4 +9,7 @@ topics: children: - /extending-copilot-chat-with-mcp - /using-the-github-mcp-server +redirect_from: + - /copilot/customizing-copilot/using-model-context-protocol --- + diff --git a/content/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server.md b/content/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server.md similarity index 98% rename from content/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server.md rename to content/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server.md index 94049676f6b5..8d0d9fde7f30 100644 --- a/content/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server.md +++ b/content/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server.md @@ -1,12 +1,14 @@ --- title: Using the GitHub MCP Server -intro: "Learn how to use the GitHub Model Context Protocol (MCP) server to extend {% data variables.copilot.copilot_chat_short %}." +intro: 'Learn how to use the GitHub Model Context Protocol (MCP) server to extend {% data variables.copilot.copilot_chat_short %}.' shortTitle: Use the GitHub MCP Server versions: feature: copilot topics: - Copilot type: how_to +redirect_from: + - /copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server --- >[!NOTE] diff --git a/content/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot.md b/content/copilot/how-tos/custom-instructions/adding-organization-custom-instructions-for-github-copilot.md similarity index 96% rename from content/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot.md rename to content/copilot/how-tos/custom-instructions/adding-organization-custom-instructions-for-github-copilot.md index 1f0b54ebd3fd..05615821e984 100644 --- a/content/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot.md +++ b/content/copilot/how-tos/custom-instructions/adding-organization-custom-instructions-for-github-copilot.md @@ -8,6 +8,8 @@ versions: feature: copilot-org-instructions topics: - Copilot +redirect_from: + - /copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot --- {% data reusables.copilot.organization-instructions-note %} diff --git a/content/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot.md b/content/copilot/how-tos/custom-instructions/adding-personal-custom-instructions-for-github-copilot.md similarity index 96% rename from content/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot.md rename to content/copilot/how-tos/custom-instructions/adding-personal-custom-instructions-for-github-copilot.md index 51ff9cbcc5e0..7d257c760c22 100644 --- a/content/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot.md +++ b/content/copilot/how-tos/custom-instructions/adding-personal-custom-instructions-for-github-copilot.md @@ -6,6 +6,8 @@ versions: feature: copilot topics: - Copilot +redirect_from: + - /copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot --- {% data reusables.copilot.personal-instructions-note %} diff --git a/content/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot.md b/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md similarity index 99% rename from content/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot.md rename to content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md index 52de7129da2f..95619016f65f 100644 --- a/content/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot.md +++ b/content/copilot/how-tos/custom-instructions/adding-repository-custom-instructions-for-github-copilot.md @@ -3,7 +3,8 @@ title: Adding repository custom instructions for GitHub Copilot shortTitle: Repository custom instructions intro: 'Create a file in a repository that gives {% data variables.product.prodname_copilot_short %} additional context for the work it does in that repository.' redirect_from: - - /copilot/customizing-copilot/adding-custom-instructions-for-github-copilot + - /copilot/customizing-copilot/adding-custom-instructions-for-github-copilot + - /copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot versions: feature: copilot topics: diff --git a/content/copilot/how-tos/custom-instructions/index.md b/content/copilot/how-tos/custom-instructions/index.md new file mode 100644 index 000000000000..2f0ea38de20a --- /dev/null +++ b/content/copilot/how-tos/custom-instructions/index.md @@ -0,0 +1,14 @@ +--- +title: Configure custom instructions for GitHub Copilot +shortTitle: Custom instructions +intro: 'Learn how to give {% data variables.product.prodname_copilot %} persistent instructions and customize responses according to your needs.' +versions: + feature: copilot +topics: + - Copilot +children: + - /adding-personal-custom-instructions-for-github-copilot + - /adding-repository-custom-instructions-for-github-copilot + - /adding-organization-custom-instructions-for-github-copilot +--- + diff --git a/content/copilot/using-github-copilot/creating-a-pull-request-summary-with-github-copilot.md b/content/copilot/how-tos/github-flow/creating-a-pull-request-summary-with-github-copilot.md similarity index 97% rename from content/copilot/using-github-copilot/creating-a-pull-request-summary-with-github-copilot.md rename to content/copilot/how-tos/github-flow/creating-a-pull-request-summary-with-github-copilot.md index ce828b56e268..50505e8dc604 100644 --- a/content/copilot/using-github-copilot/creating-a-pull-request-summary-with-github-copilot.md +++ b/content/copilot/how-tos/github-flow/creating-a-pull-request-summary-with-github-copilot.md @@ -12,6 +12,7 @@ redirect_from: - /copilot/github-copilot-enterprise/copilot-pull-request-summaries/creating-a-pull-request-summary-with-github-copilot - /copilot/github-copilot-enterprise/copilot-pull-request-summaries - /copilot/using-github-copilot/using-github-copilot-for-pull-requests + - /copilot/using-github-copilot/creating-a-pull-request-summary-with-github-copilot --- ## About {% data variables.copilot.copilot_for_prs %} diff --git a/content/copilot/how-tos/github-flow/index.md b/content/copilot/how-tos/github-flow/index.md new file mode 100644 index 000000000000..f373783061c4 --- /dev/null +++ b/content/copilot/how-tos/github-flow/index.md @@ -0,0 +1,14 @@ +--- +title: Copilot in the GitHub flow +shortTitle: GitHub flow +intro: '{% data variables.product.prodname_copilot %} enhances and integrates with many different {% data variables.product.github %} features.' +versions: + feature: copilot +topics: + - Copilot +children: + - /using-github-copilot-to-create-issues + - /creating-a-pull-request-summary-with-github-copilot + - /using-github-copilot-in-the-command-line +--- + diff --git a/content/copilot/using-github-copilot/using-github-copilot-in-the-command-line.md b/content/copilot/how-tos/github-flow/using-github-copilot-in-the-command-line.md similarity index 97% rename from content/copilot/using-github-copilot/using-github-copilot-in-the-command-line.md rename to content/copilot/how-tos/github-flow/using-github-copilot-in-the-command-line.md index ab2c87ebfe76..98d53a31767a 100644 --- a/content/copilot/using-github-copilot/using-github-copilot-in-the-command-line.md +++ b/content/copilot/how-tos/github-flow/using-github-copilot-in-the-command-line.md @@ -10,6 +10,7 @@ shortTitle: Use Copilot in the CLI redirect_from: - /copilot/github-copilot-in-the-cli/using-github-copilot-in-the-cli - /copilot/using-github-copilot/using-github-copilot-in-the-cli + - /copilot/using-github-copilot/using-github-copilot-in-the-command-line --- ## Prerequisites diff --git a/content/copilot/using-github-copilot/using-github-copilot-to-create-issues.md b/content/copilot/how-tos/github-flow/using-github-copilot-to-create-issues.md similarity index 98% rename from content/copilot/using-github-copilot/using-github-copilot-to-create-issues.md rename to content/copilot/how-tos/github-flow/using-github-copilot-to-create-issues.md index 10195cdaa001..97cc76eb7b1e 100644 --- a/content/copilot/using-github-copilot/using-github-copilot-to-create-issues.md +++ b/content/copilot/how-tos/github-flow/using-github-copilot-to-create-issues.md @@ -8,6 +8,8 @@ topics: - Copilot - Issues - Project management +redirect_from: + - /copilot/using-github-copilot/using-github-copilot-to-create-issues --- > [!NOTE] diff --git a/content/copilot/how-tos/index.md b/content/copilot/how-tos/index.md new file mode 100644 index 000000000000..d6259998ba86 --- /dev/null +++ b/content/copilot/how-tos/index.md @@ -0,0 +1,27 @@ +--- +title: How-tos for GitHub Copilot +shortTitle: How-tos +intro: 'Learn how to use {% data variables.product.prodname_copilot %}.' +versions: + feature: copilot +topics: + - Copilot +children: + - /completions + - /chat + - /agents + - /ai-models + - /context + - /custom-instructions + - /content-exclusion + - /github-flow + - /personal-settings + - /manage-your-account + - /administer + - /monitoring-your-copilot-usage-and-entitlements + - /troubleshoot + - /build-copilot-extensions +redirect_from: + - /copilot/using-github-copilot +--- + diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/disabling-github-copilot-free.md b/content/copilot/how-tos/manage-your-account/disabling-github-copilot-free.md similarity index 94% rename from content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/disabling-github-copilot-free.md rename to content/copilot/how-tos/manage-your-account/disabling-github-copilot-free.md index 32c473cba5ac..f32f2b314d0b 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/disabling-github-copilot-free.md +++ b/content/copilot/how-tos/manage-your-account/disabling-github-copilot-free.md @@ -9,6 +9,7 @@ topics: - Copilot redirect_from: - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-free/disabling-github-copilot-free + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/disabling-github-copilot-free --- {% data variables.copilot.copilot_free_short %} is automatically disabled when you have a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, or when you are granted a license through an organization or enterprise. If you want to disable {% data variables.copilot.copilot_free_short %} without subscribing to a paid plan, you can do so in your IDE and in {% data variables.product.prodname_dotcom_the_website %}. diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer.md b/content/copilot/how-tos/manage-your-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer.md similarity index 91% rename from content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer.md rename to content/copilot/how-tos/manage-your-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer.md index 7acbce53a0af..6bbebc037c16 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer.md +++ b/content/copilot/how-tos/manage-your-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer.md @@ -1,5 +1,5 @@ --- -title: Getting free access to Copilot Pro as a student, teacher, or maintainer +title: 'Getting free access to Copilot Pro as a student, teacher, or maintainer' shortTitle: Get free access to Copilot Pro intro: 'Learn how to use {% data variables.copilot.copilot_pro_short %} for free as a student, teacher, or open-source maintainer.' versions: @@ -11,6 +11,7 @@ redirect_from: - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-subscription/getting-free-access-to-copilot-as-a-student-teacher-or-maintainer - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-github-copilot-pro-subscription/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer --- ## About free {% data variables.copilot.copilot_pro %} access diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-started-with-a-copilot-plan.md b/content/copilot/how-tos/manage-your-account/getting-started-with-a-copilot-plan.md similarity index 97% rename from content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-started-with-a-copilot-plan.md rename to content/copilot/how-tos/manage-your-account/getting-started-with-a-copilot-plan.md index 1133e2f4fef7..e131712ed2b1 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-started-with-a-copilot-plan.md +++ b/content/copilot/how-tos/manage-your-account/getting-started-with-a-copilot-plan.md @@ -18,6 +18,7 @@ redirect_from: - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-subscription/subscribing-to-copilot-as-an-individual-user - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-github-copilot-pro-subscription/subscribing-to-copilot-pro-as-an-individual-user - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-free/accessing-github-copilot-free + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/getting-started-with-a-copilot-plan --- You can get started with your {% data variables.product.prodname_copilot_short %} plan by: diff --git a/content/copilot/how-tos/manage-your-account/index.md b/content/copilot/how-tos/manage-your-account/index.md new file mode 100644 index 000000000000..491d1bee26af --- /dev/null +++ b/content/copilot/how-tos/manage-your-account/index.md @@ -0,0 +1,22 @@ +--- +title: Manage your GitHub Copilot account +shortTitle: Manage your account +intro: 'Learn how to manage your {% data variables.product.prodname_copilot_short %} account.' +versions: + feature: copilot +topics: + - Copilot +children: + - /getting-started-with-a-copilot-plan + - /getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer + - /viewing-and-changing-your-copilot-plan + - /disabling-github-copilot-free + - /managing-copilot-policies-as-an-individual-subscriber +redirect_from: + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber + - /copilot/managing-copilot + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-subscription +--- + diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber.md b/content/copilot/how-tos/manage-your-account/managing-copilot-policies-as-an-individual-subscriber.md similarity index 97% rename from content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber.md rename to content/copilot/how-tos/manage-your-account/managing-copilot-policies-as-an-individual-subscriber.md index 1dce6f3675b6..a69754e91e6f 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber.md +++ b/content/copilot/how-tos/manage-your-account/managing-copilot-policies-as-an-individual-subscriber.md @@ -13,6 +13,7 @@ redirect_from: - /github/copilot/github-copilot-telemetry-terms - /copilot/configuring-github-copilot/configuring-your-personal-github-copilot-settings-on-githubcom - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-policies-as-an-individual-subscriber + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber --- ## About {% data variables.product.prodname_copilot %} settings on {% data variables.product.github %} diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/viewing-and-changing-your-copilot-plan.md b/content/copilot/how-tos/manage-your-account/viewing-and-changing-your-copilot-plan.md similarity index 98% rename from content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/viewing-and-changing-your-copilot-plan.md rename to content/copilot/how-tos/manage-your-account/viewing-and-changing-your-copilot-plan.md index 7a32e32993eb..5ca83f038fdc 100644 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/viewing-and-changing-your-copilot-plan.md +++ b/content/copilot/how-tos/manage-your-account/viewing-and-changing-your-copilot-plan.md @@ -20,6 +20,7 @@ redirect_from: - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-subscription/canceling-your-copilot-trial-as-an-individual-user - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-github-copilot-pro-subscription/canceling-your-copilot-pro-trial-as-an-individual-user - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/canceling-your-copilot-plan + - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/viewing-and-changing-your-copilot-plan --- You can view your current plan details in your {% data variables.product.github %} account settings. From there, you can change or cancel your plan, or switch between monthly and yearly billing based on your needs. diff --git a/content/copilot/managing-copilot/understanding-and-managing-copilot-usage/monitoring-your-copilot-usage-and-entitlements.md b/content/copilot/how-tos/monitoring-your-copilot-usage-and-entitlements.md similarity index 91% rename from content/copilot/managing-copilot/understanding-and-managing-copilot-usage/monitoring-your-copilot-usage-and-entitlements.md rename to content/copilot/how-tos/monitoring-your-copilot-usage-and-entitlements.md index b8dbad7bc48a..a6c04352c565 100644 --- a/content/copilot/managing-copilot/understanding-and-managing-copilot-usage/monitoring-your-copilot-usage-and-entitlements.md +++ b/content/copilot/how-tos/monitoring-your-copilot-usage-and-entitlements.md @@ -1,8 +1,8 @@ --- title: Monitoring your Copilot usage and entitlements -shortTitle: Monitor your Copilot usage and entitlements -intro: Learn how you can monitor your monthly usage of {% data variables.product.prodname_copilot_short %} and get the most value out of your {% data variables.product.prodname_copilot_short %} plan. -permissions: Individual users on a paid {% data variables.product.prodname_copilot_short %} plan can view their own usage and entitlements. For {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plans, organization admins and billing managers can view usage reports for members. +shortTitle: Monitor usage and entitlements +intro: 'Learn how you can monitor your monthly usage of {% data variables.product.prodname_copilot_short %} and get the most value out of your {% data variables.product.prodname_copilot_short %} plan.' +permissions: 'Individual users on a paid {% data variables.product.prodname_copilot_short %} plan can view their own usage and entitlements. For {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plans, organization admins and billing managers can view usage reports for members.' versions: feature: copilot topics: @@ -10,6 +10,7 @@ topics: redirect_from: - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/monitoring-usage-and-entitlements/monitoring-your-copilot-usage-and-entitlements - /copilot/managing-copilot/monitoring-usage-and-entitlements/monitoring-your-copilot-usage-and-entitlements + - /copilot/managing-copilot/understanding-and-managing-copilot-usage/monitoring-your-copilot-usage-and-entitlements --- You can track your monthly usage of premium requests to help you get the most value from your {% data variables.product.prodname_copilot_short %} plan. diff --git a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-the-cli.md b/content/copilot/how-tos/personal-settings/configuring-github-copilot-in-the-cli.md similarity index 96% rename from content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-the-cli.md rename to content/copilot/how-tos/personal-settings/configuring-github-copilot-in-the-cli.md index 32d906987104..69f9ad513ea0 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-the-cli.md +++ b/content/copilot/how-tos/personal-settings/configuring-github-copilot-in-the-cli.md @@ -9,6 +9,7 @@ topics: - CLI redirect_from: - /copilot/github-copilot-in-the-cli/configuring-github-copilot-in-the-cli + - /copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-the-cli --- ## Setting up aliases diff --git a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md b/content/copilot/how-tos/personal-settings/configuring-github-copilot-in-your-environment.md similarity index 99% rename from content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md rename to content/copilot/how-tos/personal-settings/configuring-github-copilot-in-your-environment.md index 3d4ef0e2ecea..b7d782452bc3 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment.md +++ b/content/copilot/how-tos/personal-settings/configuring-github-copilot-in-your-environment.md @@ -8,6 +8,7 @@ redirect_from: - /copilot/configuring-github-copilot/configuring-github-copilot-in-a-jetbrains-ide - /copilot/configuring-github-copilot/configuring-github-copilot-in-neovim - /copilot/configuring-github-copilot/configuring-github-copilot-in-your-environment + - /copilot/managing-copilot/configure-personal-settings/configuring-github-copilot-in-your-environment topics: - Copilot versions: diff --git a/content/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot.md b/content/copilot/how-tos/personal-settings/configuring-network-settings-for-github-copilot.md similarity index 99% rename from content/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot.md rename to content/copilot/how-tos/personal-settings/configuring-network-settings-for-github-copilot.md index 163a8e91353d..9900aa64c6b3 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot.md +++ b/content/copilot/how-tos/personal-settings/configuring-network-settings-for-github-copilot.md @@ -8,6 +8,7 @@ versions: feature: copilot redirect_from: - /copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot + - /copilot/managing-copilot/configure-personal-settings/configuring-network-settings-for-github-copilot --- {% visualstudio %} diff --git a/content/copilot/managing-copilot/configure-personal-settings/index.md b/content/copilot/how-tos/personal-settings/index.md similarity index 82% rename from content/copilot/managing-copilot/configure-personal-settings/index.md rename to content/copilot/how-tos/personal-settings/index.md index 095bd93c1960..2c6d0f5e8213 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/index.md +++ b/content/copilot/how-tos/personal-settings/index.md @@ -1,6 +1,6 @@ --- -title: Configuring personal settings -shortTitle: Configure personal settings +title: Configure personal settings +shortTitle: Personal settings intro: 'You can manage the configuration of {% data variables.product.prodname_copilot %} in a supported IDE or on {% data variables.product.github %}.' versions: feature: copilot @@ -13,7 +13,8 @@ children: - /configuring-github-copilot-in-your-environment - /configuring-github-copilot-in-the-cli - /using-github-copilot-with-an-account-on-ghecom - redirect_from: - /copilot/configuring-github-copilot + - /copilot/managing-copilot/configure-personal-settings --- + diff --git a/content/copilot/managing-copilot/configure-personal-settings/installing-github-copilot-in-the-cli.md b/content/copilot/how-tos/personal-settings/installing-github-copilot-in-the-cli.md similarity index 95% rename from content/copilot/managing-copilot/configure-personal-settings/installing-github-copilot-in-the-cli.md rename to content/copilot/how-tos/personal-settings/installing-github-copilot-in-the-cli.md index d9687fb54e9c..e00895215ddb 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/installing-github-copilot-in-the-cli.md +++ b/content/copilot/how-tos/personal-settings/installing-github-copilot-in-the-cli.md @@ -11,6 +11,7 @@ redirect_from: - /copilot/github-copilot-in-the-cli/enabling-github-copilot-in-the-cli - /copilot/github-copilot-in-the-cli/setting-up-github-copilot-in-the-cli - /copilot/github-copilot-in-the-cli/installing-github-copilot-in-the-cli + - /copilot/managing-copilot/configure-personal-settings/installing-github-copilot-in-the-cli --- ## Prerequisites diff --git a/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md b/content/copilot/how-tos/personal-settings/installing-the-github-copilot-extension-in-your-environment.md similarity index 99% rename from content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md rename to content/copilot/how-tos/personal-settings/installing-the-github-copilot-extension-in-your-environment.md index 36d1f79c81d3..86e0be365f16 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment.md +++ b/content/copilot/how-tos/personal-settings/installing-the-github-copilot-extension-in-your-environment.md @@ -9,6 +9,7 @@ topics: - Copilot redirect_from: - /copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment + - /copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment --- ## Prerequisite diff --git a/content/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom.md b/content/copilot/how-tos/personal-settings/using-github-copilot-with-an-account-on-ghecom.md similarity index 98% rename from content/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom.md rename to content/copilot/how-tos/personal-settings/using-github-copilot-with-an-account-on-ghecom.md index cc67c0b0f177..24c8b7044606 100644 --- a/content/copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom.md +++ b/content/copilot/how-tos/personal-settings/using-github-copilot-with-an-account-on-ghecom.md @@ -7,6 +7,8 @@ versions: defaultTool: vscode topics: - Copilot +redirect_from: + - /copilot/managing-copilot/configure-personal-settings/using-github-copilot-with-an-account-on-ghecom --- To use {% data variables.product.prodname_copilot %} in an IDE or the command line, you must authenticate to an account on {% data variables.product.github %} that has a {% data variables.product.prodname_copilot_short %} license. diff --git a/content/copilot/troubleshooting-github-copilot/index.md b/content/copilot/how-tos/troubleshoot/index.md similarity index 79% rename from content/copilot/troubleshooting-github-copilot/index.md rename to content/copilot/how-tos/troubleshoot/index.md index cccc455549b7..b1885a72d6f8 100644 --- a/content/copilot/troubleshooting-github-copilot/index.md +++ b/content/copilot/how-tos/troubleshoot/index.md @@ -1,6 +1,6 @@ --- -title: Troubleshooting GitHub Copilot -shortTitle: Troubleshooting +title: Troubleshoot GitHub Copilot +shortTitle: Troubleshoot intro: 'These guides provide information for troubleshooting {% data variables.product.prodname_copilot %}.' versions: fpt: '*' @@ -12,4 +12,7 @@ children: - /troubleshooting-firewall-settings-for-github-copilot - /troubleshooting-network-errors-for-github-copilot - /troubleshooting-issues-with-github-copilot-chat +redirect_from: + - /copilot/troubleshooting-github-copilot --- + diff --git a/content/copilot/troubleshooting-github-copilot/rate-limits-for-github-copilot.md b/content/copilot/how-tos/troubleshoot/rate-limits-for-github-copilot.md similarity index 96% rename from content/copilot/troubleshooting-github-copilot/rate-limits-for-github-copilot.md rename to content/copilot/how-tos/troubleshoot/rate-limits-for-github-copilot.md index 0dbf75cae3f9..96dc5088939f 100644 --- a/content/copilot/troubleshooting-github-copilot/rate-limits-for-github-copilot.md +++ b/content/copilot/how-tos/troubleshoot/rate-limits-for-github-copilot.md @@ -6,6 +6,8 @@ versions: feature: copilot topics: - Copilot +redirect_from: + - /copilot/troubleshooting-github-copilot/rate-limits-for-github-copilot --- Rate limiting is a mechanism used to control the number of requests a user or application can make in a given time period. {% data variables.product.github %} uses rate limits to ensure everyone has fair access to {% data variables.product.prodname_copilot %} and to protect against abuse. diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot.md b/content/copilot/how-tos/troubleshoot/troubleshooting-common-issues-with-github-copilot.md similarity index 98% rename from content/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot.md rename to content/copilot/how-tos/troubleshoot/troubleshooting-common-issues-with-github-copilot.md index e41d6267ed60..e6e054f6f4ce 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot.md +++ b/content/copilot/how-tos/troubleshoot/troubleshooting-common-issues-with-github-copilot.md @@ -6,6 +6,8 @@ versions: topics: - Copilot shortTitle: Common issues with GitHub Copilot +redirect_from: + - /copilot/troubleshooting-github-copilot/troubleshooting-common-issues-with-github-copilot --- diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot.md b/content/copilot/how-tos/troubleshoot/troubleshooting-firewall-settings-for-github-copilot.md similarity index 89% rename from content/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot.md rename to content/copilot/how-tos/troubleshoot/troubleshooting-firewall-settings-for-github-copilot.md index 04fff63aa6ce..a1ea91306739 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot.md +++ b/content/copilot/how-tos/troubleshoot/troubleshooting-firewall-settings-for-github-copilot.md @@ -8,6 +8,8 @@ topics: versions: feature: copilot shortTitle: Connectivity security settings +redirect_from: + - /copilot/troubleshooting-github-copilot/troubleshooting-firewall-settings-for-github-copilot --- ## About the problem diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat.md b/content/copilot/how-tos/troubleshoot/troubleshooting-issues-with-github-copilot-chat.md similarity index 98% rename from content/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat.md rename to content/copilot/how-tos/troubleshoot/troubleshooting-issues-with-github-copilot-chat.md index 18f2ddab9161..496d01d5f7a5 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat.md +++ b/content/copilot/how-tos/troubleshoot/troubleshooting-issues-with-github-copilot-chat.md @@ -12,6 +12,7 @@ shortTitle: Copilot Chat redirect_from: - /copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat-in-ides - /copilot/troubleshooting-github-copilot/troubleshooting-authentication-issues-with-github-copilot-chat + - /copilot/troubleshooting-github-copilot/troubleshooting-issues-with-github-copilot-chat --- You can use {% data variables.copilot.copilot_chat %} in your IDE or on the {% data variables.product.github %} website. Click the tabs above for troubleshooting information for {% data variables.product.prodname_copilot_short %} in {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode %}, and on {% data variables.product.github %} in the browser. diff --git a/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md b/content/copilot/how-tos/troubleshoot/troubleshooting-network-errors-for-github-copilot.md similarity index 98% rename from content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md rename to content/copilot/how-tos/troubleshoot/troubleshooting-network-errors-for-github-copilot.md index 00ddc539571a..179ad3b33794 100644 --- a/content/copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot.md +++ b/content/copilot/how-tos/troubleshoot/troubleshooting-network-errors-for-github-copilot.md @@ -7,6 +7,7 @@ topics: - Troubleshooting redirect_from: - /copilot/troubleshooting-github-copilot/troubleshooting-certificate-errors-for-github-copilot + - /copilot/troubleshooting-github-copilot/troubleshooting-network-errors-for-github-copilot versions: feature: copilot shortTitle: Network errors diff --git a/content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md b/content/copilot/how-tos/troubleshoot/viewing-logs-for-github-copilot-in-your-environment.md similarity index 99% rename from content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md rename to content/copilot/how-tos/troubleshoot/viewing-logs-for-github-copilot-in-your-environment.md index 5c6722600267..63b68d5bb481 100644 --- a/content/copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment.md +++ b/content/copilot/how-tos/troubleshoot/viewing-logs-for-github-copilot-in-your-environment.md @@ -7,6 +7,7 @@ redirect_from: - /copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-a-jetbrains-ide - /copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-neovim - /copilot/troubleshooting-github-copilot/troubleshooting-github-copilot-in-your-environment + - /copilot/troubleshooting-github-copilot/viewing-logs-for-github-copilot-in-your-environment topics: - Copilot - Logging diff --git a/content/copilot/index.md b/content/copilot/index.md index 0f13c01265fd..c5bcb446e86e 100644 --- a/content/copilot/index.md +++ b/content/copilot/index.md @@ -14,27 +14,23 @@ featuredLinks: startHere: - /copilot/get-started/what-is-github-copilot - /copilot/get-started/quickstart - - /copilot/building-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents + - /copilot/how-tos/build-copilot-extensions/quickstart-for-github-copilot-extensions-using-agents - /copilot/concepts/about-assigning-tasks-to-copilot popular: - /copilot/get-started/github-copilot-features - /copilot/tutorials/copilot-chat-cookbook - - /copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot - - /copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide - - /copilot/using-github-copilot/using-github-copilot-in-the-command-line + - /copilot/how-tos/completions/getting-code-suggestions-in-your-ide-with-github-copilot + - /copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide + - /copilot/how-tos/github-flow/using-github-copilot-in-the-command-line layout: product-landing versions: feature: copilot children: - /get-started - /concepts - - /using-github-copilot - - /managing-copilot - - /customizing-copilot + - /how-tos - /reference - /tutorials - - /building-copilot-extensions - - /troubleshooting-github-copilot - /responsible-use-of-github-copilot-features topics: - Copilot diff --git a/content/copilot/managing-copilot/index.md b/content/copilot/managing-copilot/index.md deleted file mode 100644 index a8bb2d4852a5..000000000000 --- a/content/copilot/managing-copilot/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Managing Copilot -shortTitle: Manage Copilot -intro: 'Learn how to manage and configure {% data variables.product.prodname_copilot_short %}.' -versions: - feature: copilot -topics: - - Copilot -children: - - /managing-copilot-as-an-individual-subscriber - - /managing-github-copilot-in-your-organization - - /managing-copilot-for-your-enterprise - - /understanding-and-managing-copilot-usage - - /configure-personal-settings - - /configuring-and-auditing-content-exclusion ---- diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/index.md b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/index.md deleted file mode 100644 index 5205f49f1079..000000000000 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/getting-started-with-copilot-on-your-personal-account/index.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Getting started with Copilot on your personal account -shortTitle: Get started with Copilot -intro: 'Learn how to choose the right {% data variables.product.prodname_copilot_short %} plan for your needs and get started with setup on your personal account.' -versions: - feature: copilot -topics: - - Copilot -children: - - /getting-started-with-a-copilot-plan - - /getting-free-access-to-copilot-pro-as-a-student-teacher-or-maintainer -redirect_from: - - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-copilot-free ---- - diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/index.md b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/index.md deleted file mode 100644 index e9c8ccc3057a..000000000000 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/index.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Managing Copilot as an individual subscriber -shortTitle: Manage for individual -intro: 'Individual users can subscribe to {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, or {% data variables.copilot.copilot_free_short %} for personal use.' -versions: - feature: copilot -topics: - - Copilot -children: - - /getting-started-with-copilot-on-your-personal-account - - /managing-your-copilot-plan ---- diff --git a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/index.md b/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/index.md deleted file mode 100644 index a4c4240504f2..000000000000 --- a/content/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: Managing your Copilot plan -shortTitle: Manage your Copilot plan -intro: 'Learn how to view, change, or cancel your {% data variables.product.prodname_copilot_short %} plan, manage personal settings and policies, and extend {% data variables.product.prodname_copilot_short %}’s capabilities in your personal account.' -versions: - feature: copilot -topics: - - Copilot -children: - - /viewing-and-changing-your-copilot-plan - - /disabling-github-copilot-free - - /managing-copilot-policies-as-an-individual-subscriber - - /extending-the-capabilities-of-github-copilot-in-your-personal-account -redirect_from: - - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-subscription - - /copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-github-copilot-pro-subscription ---- diff --git a/content/copilot/managing-copilot/understanding-and-managing-copilot-usage/index.md b/content/copilot/managing-copilot/understanding-and-managing-copilot-usage/index.md deleted file mode 100644 index acb025546b00..000000000000 --- a/content/copilot/managing-copilot/understanding-and-managing-copilot-usage/index.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Understanding and managing Copilot usage -shortTitle: Understand and manage usage -intro: 'You can track your {% data variables.product.prodname_copilot_short %} usage and premium request entitlements to understand how you''re using {% data variables.product.prodname_copilot_short %} and make informed decisions about your plan and spending.' -versions: - feature: copilot -topics: - - Copilot -children: - - /monitoring-your-copilot-usage-and-entitlements -redirect_from: - - /copilot/managing-copilot/monitoring-usage-and-entitlements ---- - diff --git a/content/copilot/using-github-copilot/index.md b/content/copilot/using-github-copilot/index.md deleted file mode 100644 index dc89ef943309..000000000000 --- a/content/copilot/using-github-copilot/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: Using GitHub Copilot -shortTitle: Use GitHub Copilot -intro: 'Use {% data variables.product.prodname_copilot %} to increase your productivity.' -versions: - feature: copilot -topics: - - Copilot -children: - - /getting-code-suggestions-in-your-ide-with-github-copilot - - /copilot-chat - - /copilot-spaces - - /coding-agent - - /asking-github-copilot-questions-in-windows-terminal - - /using-copilot-text-completion - - /code-review - - /using-github-copilot-in-the-command-line - - /using-extensions-to-integrate-external-tools-with-copilot-chat - - /ai-models - - /finding-public-code-that-matches-github-copilot-suggestions - - /creating-a-pull-request-summary-with-github-copilot - - /using-github-copilot-to-create-issues -redirect_from: - - /copilot/github-copilot-chat - - /copilot/github-copilot-in-the-cli ---- - diff --git a/content/index.md b/content/index.md index 54c915288405..2b2d02ba2191 100644 --- a/content/index.md +++ b/content/index.md @@ -9,7 +9,7 @@ featuredLinks: popular: - /pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests - /authentication - - /copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot + - /copilot/how-tos/completions/getting-code-suggestions-in-your-ide-with-github-copilot - /get-started/git-basics/managing-remote-repositories - /pages redirect_from: @@ -106,11 +106,11 @@ childGroups: octicon: CopilotIcon children: - copilot - - copilot/using-github-copilot/getting-code-suggestions-in-your-ide-with-github-copilot + - copilot/how-tos/completions/getting-code-suggestions-in-your-ide-with-github-copilot - copilot/concepts/prompt-engineering-for-copilot-chat - - copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-github + - copilot/how-tos/chat/asking-github-copilot-questions-in-github - copilot/tutorials/copilot-chat-cookbook - - copilot/using-github-copilot/coding-agent + - copilot/how-tos/agents/copilot-coding-agent - name: CI/CD and DevOps octicon: GearIcon children: @@ -153,7 +153,7 @@ childGroups: - rest - graphql - webhooks - - copilot/building-copilot-extensions + - copilot/how-tos/build-copilot-extensions - github-models - name: Community octicon: GlobeIcon @@ -192,3 +192,4 @@ externalProducts: href: 'https://wellarchitected.github.com/' external: true --- + diff --git a/src/rest/components/get-rest-code-samples.ts b/src/rest/components/get-rest-code-samples.ts index ef2706368eae..aecb40a7d41f 100644 --- a/src/rest/components/get-rest-code-samples.ts +++ b/src/rest/components/get-rest-code-samples.ts @@ -4,6 +4,13 @@ import { stringify } from 'javascript-stringify' import type { CodeSample, Operation } from '@/rest/components/types' import { type VersionItem } from '@/frame/components/context/MainContext' +// Helper function to escape shell values containing single quotes (contractions) +// This prevents malformed shell commands when contractions like "there's" are used +function escapeShellValue(value: string): string { + // Replace single quotes with '\'' to properly escape them in shell commands + return value.replace(/'/g, "'\\''") +} + type CodeExamples = Record // If the content type is application/x-www-form-urlencoded the format of @@ -77,10 +84,12 @@ export function getShellExample( if (bodyParameters && typeof bodyParameters === 'object' && !Array.isArray(bodyParameters)) { const paramNames = Object.keys(bodyParameters) paramNames.forEach((elem) => { - requestBodyParams = `${requestBodyParams} ${CURL_CONTENT_TYPE_MAPPING[contentType]} '${elem}=${bodyParameters[elem]}'` + const escapedValue = escapeShellValue(String(bodyParameters[elem])) + requestBodyParams = `${requestBodyParams} ${CURL_CONTENT_TYPE_MAPPING[contentType]} '${elem}=${escapedValue}'` }) } else { - requestBodyParams = `${CURL_CONTENT_TYPE_MAPPING[contentType]} "${bodyParameters}"` + const escapedValue = escapeShellValue(String(bodyParameters)) + requestBodyParams = `${CURL_CONTENT_TYPE_MAPPING[contentType]} "${escapedValue}"` } } } @@ -210,7 +219,9 @@ function handleSingleParameter( separator = '' } if (typeof value === 'string') { - cliLine += ` -f "${keyString}${separator}${value}"` + // Escape single quotes in string values to prevent shell command issues with contractions + const escapedValue = escapeShellValue(value) + cliLine += ` -f '${keyString}${separator}${escapedValue}'` } else if (typeof value === 'number' || typeof value === 'boolean' || value === null) { cliLine += ` -F "${keyString}${separator}${value}"` } else if (Array.isArray(value)) { diff --git a/src/rest/tests/cli-examples.js b/src/rest/tests/cli-examples.js new file mode 100644 index 000000000000..79309c695373 --- /dev/null +++ b/src/rest/tests/cli-examples.js @@ -0,0 +1,167 @@ +import { describe, expect, test } from 'vitest' + +import { getGHExample, getShellExample } from '../components/get-rest-code-samples.ts' + +describe('CLI examples generation', () => { + const mockOperation = { + verb: 'patch', + requestPath: '/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}', + serverUrl: 'https://api.github.com', + subcategory: 'code-scanning', + parameters: [], + } + + const mockVersions = { + 'free-pro-team@latest': { + apiVersions: ['2022-11-28'], + latestApiVersion: '2022-11-28', + }, + } + + test('GitHub CLI example properly escapes contractions in string values', () => { + const codeSample = { + request: { + parameters: { + owner: 'OWNER', + repo: 'REPO', + alert_number: 'ALERT_NUMBER', + }, + bodyParameters: { + state: 'dismissed', + dismissed_reason: 'false positive', + dismissed_comment: + "This alert is not actually correct, because there's a sanitizer included in the library.", + }, + }, + } + + const result = getGHExample(mockOperation, codeSample, 'free-pro-team@latest', mockVersions) + + // Check that the contraction is properly escaped + expect(result).toContain("there'\\''s") + // Ensure the command is properly formatted + expect(result).toContain('gh api') + expect(result).toContain('--method PATCH') + expect(result).toContain("-f 'dismissed_comment=") + }) + + test('cURL example properly escapes contractions in JSON body', () => { + const codeSample = { + request: { + parameters: { + owner: 'OWNER', + repo: 'REPO', + alert_number: 'ALERT_NUMBER', + }, + bodyParameters: { + state: 'dismissed', + dismissed_reason: 'false positive', + dismissed_comment: + "This alert is not actually correct, because there's a sanitizer included in the library.", + }, + contentType: 'application/json', + }, + } + + const result = getShellExample(mockOperation, codeSample, 'free-pro-team@latest', mockVersions) + + // Check that the JSON string is properly escaped + expect(result).toContain("there'\\''s") + expect(result).toContain('curl -L') + expect(result).toContain('-X PATCH') + }) + + test('GitHub CLI example handles multiple contractions', () => { + const codeSample = { + request: { + parameters: { + owner: 'OWNER', + repo: 'REPO', + }, + bodyParameters: { + title: "Here's what's wrong with the code", + body: "It's not working because there's an issue and we can't fix it", + }, + }, + } + + const mockSimpleOperation = { + verb: 'post', + requestPath: '/repos/{owner}/{repo}/issues', + serverUrl: 'https://api.github.com', + subcategory: 'issues', + parameters: [], + } + + const result = getGHExample( + mockSimpleOperation, + codeSample, + 'free-pro-team@latest', + mockVersions, + ) + + // Check that all contractions are properly escaped + expect(result).toContain("Here'\\''s what'\\''s") + expect(result).toContain("It'\\''s not working") + expect(result).toContain("there'\\''s an issue") + expect(result).toContain("can'\\''t fix") + }) + + test('GitHub CLI example handles values without contractions normally', () => { + const codeSample = { + request: { + parameters: { + owner: 'OWNER', + repo: 'REPO', + }, + bodyParameters: { + state: 'dismissed', + dismissed_reason: 'false positive', + dismissed_comment: + 'This alert is not actually correct because there is a sanitizer included in the library.', + }, + }, + } + + const result = getGHExample(mockOperation, codeSample, 'free-pro-team@latest', mockVersions) + + // Check that normal text is not modified + expect(result).toContain('there is a sanitizer') + expect(result).not.toContain("'\\''") + expect(result).toContain('gh api') + }) + + test('cURL example with form data properly escapes contractions', () => { + const codeSample = { + request: { + parameters: { + owner: 'OWNER', + repo: 'REPO', + }, + bodyParameters: { + comment: "Here's my feedback on this PR", + }, + contentType: 'application/x-www-form-urlencoded', + }, + } + + const mockSimpleOperation = { + verb: 'post', + requestPath: '/repos/{owner}/{repo}/pulls/{pull_number}/reviews', + serverUrl: 'https://api.github.com', + subcategory: 'pulls', + parameters: [], + } + + const result = getShellExample( + mockSimpleOperation, + codeSample, + 'free-pro-team@latest', + mockVersions, + ) + + // Check that form data values are properly escaped + expect(result).toContain("Here'\\''s my feedback") + expect(result).toContain('--data-urlencode') + }) +})