Merge pull request #21107 from dvdksn/copilot-restructure

copilot: restructure content, editorial improvements

.github/labeler.yml

@@ -159,6 +159,11 @@ area/accounts:
       - any-glob-to-any-file:
           - content/manuals/accounts/**
 
+area/copilot:
+  - changed-files:
+      - any-glob-to-any-file:
+          - content/manuals/copilot/**
+
 hugo:
   - changed-files:
       - any-glob-to-any-file:

content/manuals/copilot/_index.md

@@ -0,0 +1,68 @@
+---
+title: Docker for GitHub Copilot
+params:
+  sidebar:
+    badge:
+      color: violet
+      text: EA
+weight: 100
+description: |
+  Learn how to streamline Docker-related tasks with the Docker for GitHub
+  Copilot extension. This integration helps you generate Docker assets, analyze
+  vulnerabilities, and automate containerization through GitHub Copilot Chat in
+  various development environments.
+keywords: Docker, GitHub Copilot, extension, Visual Studio Code, chat, ai, containerization
+---
+
+{{% restricted title="Early Access" %}}
+The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
+{{% /restricted %}}
+
+The [Docker for GitHub Copilot](https://github.com/marketplace/docker-for-github-copilot)
+extension integrates Docker's capabilities with GitHub Copilot, providing
+assistance with containerizing applications, generating Docker assets, and
+analyzing project vulnerabilities. This extension helps you streamline
+Docker-related tasks wherever GitHub Copilot Chat is available.
+
+## Key features
+
+Key features of the Docker for GitHub Copilot extension include:
+
+- Ask questions and receive responses about containerization in any context
+  where GitHub Copilot Chat is available, such as on GitHub.com and in Visual Studio Code.
+- Automatically generate Dockerfiles, Docker Compose files, and `.dockerignore`
+  files for a project.
+- Open pull requests with generated Docker assets directly from the chat
+  interface.
+- Get summaries of project vulnerabilities from [Docker
+  Scout](/manuals/scout/_index.md) and receive next steps via the CLI.
+
+## Data Privacy
+
+The Docker agent is trained exclusively on Docker's documentation and tools to
+assist with containerization and related tasks. It does not have access to your
+project's data outside the context of the questions you ask.
+
+When using the Docker Extension for GitHub Copilot, GitHub Copilot may include
+a reference to the currently open file in its request if authorized by the
+user. The Docker agent can read the file to provide context-aware responses.
+
+If the agent is requested to check for vulnerabilities or generate
+Docker-related assets, it will clone the referenced repository into in-memory
+storage to perform the necessary actions.
+
+Source code or project metadata is never persistently stored. Questions and
+answers are retained for analytics and troubleshooting. Data processed by the
+Docker agent is never shared with third parties.
+
+## Supported languages
+
+The Docker Extension for GitHub Copilot supports the following programming
+languages for tasks involving containerizing a project from scratch:
+
+- Go
+- Java
+- JavaScript
+- Python
+- Rust
+- TypeScript

content/manuals/copilot/examples.md

@@ -0,0 +1,63 @@
+---
+title: Example prompts for the Docker agent
+linkTitle: Example prompts
+description: |
+  Discover example prompts to interact with the Docker agent and learn how to
+  automate tasks like Dockerizing projects or opening pull requests.
+weight: 30
+---
+
+{{% restricted title="Early Access" %}}
+The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
+{{% /restricted %}}
+
+## Use cases
+
+Here are some examples of the types of questions you can ask the Docker agent:
+
+### Ask general Docker questions
+
+You can ask general question about Docker. For example:
+
+- `@docker what is a Dockerfile?`
+- `@docker how do I build a Docker image?`
+- `@docker how do I run a Docker container?`
+- `@docker what does 'docker buildx imagetools inspect' do?`
+
+### Get help containerizing your project
+
+You can ask the agent to help you containerize your existing project:
+
+- `@docker can you help create a compose file for this project?`
+- `@docker can you create a Dockerfile for this project?`
+
+#### Opening pull requests
+
+The Docker agent will analyze your project, generate the necessary files, and,
+if applicable, offer to raise a pull request with the necessary Docker assets.
+
+Automatically opening pull requests against your repositories is only available
+when the agent generates new Docker assets.
+
+### Analyze a project for vulnerabilities
+
+The agent can help you improve your security posture with [Docker
+Scout](/manuals/scout/_index.md):
+
+- `@docker can you help me find vulnerabilities in my project?`
+- `@docker does my project contain any insecure dependencies?`
+
+The agent will run use Docker Scout to analyze your project's dependencies, and
+report whether you're vulnerable to any [known CVEs](/manuals/scout/deep-dive/advisory-db-sources.md).
+
+![Copilot vulnerabilities report](images/copilot-vuln-report.png?w=500px&border=1)
+
+## Limitations
+
+- The agent is currently not able to access specific files in your repository,
+  such as the currently-opened file in your editor, or if you pass a file
+  reference with your message in the chat message.
+
+## Feedback
+
+For issues or feedback, visit the [GitHub feedback repository](https://github.com/docker/copilot-issues).

content/manuals/copilot/index.md

@@ -1,197 +0,0 @@
----
-title: Docker for GitHub Copilot
-linkTitle: Docker for GitHub Copilot
-params:
-  sidebar:
-    badge:
-      color: violet
-      text: Early Access
-weight: 100
-description: Learn how to use the Docker Extension for GitHub Copilot to streamline Docker-related tasks.
-keywords: Docker, GitHub Copilot, extension, Visual Studio Code, chat, ai, containerization
----
-
-{{% restricted title="Early access" %}}
-
-The Docker Extension for GitHub Copilot is a part of the [Limited Public Beta](https://github.blog/changelog/2024-05-21-copilot-extensions-now-in-limited-public-beta/)
-for GitHub Copilot Extensions.
-
-To get access, [sign up for the Copilot Extensions waitlist](https://github.com/github-copilot/copilot_extensions_waitlist_signup).
-
-{{% /restricted %}}
-
-The Docker Extension for GitHub Copilot integrates Docker's capabilities with
-GitHub Copilot, providing assistance with containerizing applications and
-generating Docker assets. This extension helps you streamline Docker-related
-tasks wherever GitHub Copilot Chat is available.
-
-The key features are:
-
-- Ask questions and receive responses about containerization in any context
-  when GitHub Copilot Chat is available, such as on GitHub.com and in Visual Studio Code.
-- Automatically generate Dockerfiles, Docker Compose files, and .dockerignore
-  files for a project.
-- Open pull requests with generated Docker assets directly from the chat
-  interface.
-- Get summaries of project vulnerabilities from Docker Scout and receive next
-  steps via CLI.
-
-## Data Privacy
-
-The Docker agent is trained exclusively on Docker's documentation and tools to
-assist with containerization and related tasks. It does not have access to your
-project's data outside the context of the questions you ask.
-
-When using the Docker Extension for GitHub Copilot, GitHub Copilot may include
-a reference to the currently open file in its request if authorized by the
-user. The Docker agent can read the file to provide context-aware responses.
-
-If the agent is requested to check for vulnerabilities or generate
-Docker-related assets, it will clone the referenced repository into in-memory
-storage to perform the necessary actions.
-
-Source code, questions, and responses are not persistently stored. The Docker
-agent processes data only to provide responses and discards it immediately
-afterward.
-
-## Supported languages
-
-The Docker Extension for GitHub Copilot supports the following
-programming languages:
-
-- Dockerfile
-- Go
-- Java
-- JavaScript
-- Python
-- Rust
-- TypeScript
-
-## Get Started
-
-Here's how to get started with the Docker Extension for GitHub Copilot.
-
-### Prerequisites
-
-Before you start, ensure that:
-
-- You have been granted access to GitHub's [limited public beta program](https://github.blog/changelog/2024-05-21-copilot-extensions-now-in-limited-public-beta/).
-- You're signed in to your GitHub account on GitHub.com.
-
-### Install the extension for your organization
-
-1. Go to the [Docker for GitHub Copilot](https://github.com/marketplace/docker-for-github-copilot)
-   app in the GitHub Marketplace.
-
-2. Select the **Add** button at the top of the page.
-
-3. Under **Pricing and setup**, select the organization that you want to
-   install the extension for and select **Install it for free**.
-
-4. Select the **Complete order and begin installation** button.
-
-5. Select the repositories where you want to use the Docker Extension for
-   GitHub Copilot and finish with **Install**.
-
-> [!NOTE]
-> Before you can use Copilot Extensions in your organization, you need to
-> enable the Copilot Extensions policy. For more information, see
-> [Setting a policy for GitHub Copilot Extensions in your organization](https://docs.github.com/en/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#setting-a-policy-for-github-copilot-extensions-in-your-organization).
-
-### Set up Copilot Chat
-
-Once you've installed the Docker Extension for GitHub Copilot and enabled the
-Copilot Extensions policy, you can use the extension in your editor or IDE, or
-on GitHub.com.
-
-{{< tabs >}}
-{{< tab name="Editor or IDE" >}}
-
-For instructions on how to use the Docker Extension for GitHub Copilot in
-your editor, see:
-
-- [Visual Studio Code](https://docs.github.com/en/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=vscode)
-- [Visual Studio](https://docs.github.com/en/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=visualstudio)
-- [Codespaces](https://docs.github.com/en/codespaces/reference/using-github-copilot-in-github-codespaces)
-
-{{< /tab >}}
-{{< tab name="GitHub.com" >}}
-
-No setup is needed for the Docker Extension for GitHub Copilot on GitHub.com.
-Simply go to any repository and start using the chat interface,
-see [Using the extension](#using-the-extension).
-
-{{< /tab >}}
-{{< /tabs >}}
-
-You can verify that the extension has been properly installed by typing
-`@docker` in the Copilot Chat window. As you type, you should see the Docker
-agent appear in the chat interface.
-
-![Docker agent in chat](/copilot/docker-agent-copilot.png)
-
-## Using the extension
-
-The Docker Extension for GitHub Copilot provides a chat interface that you can
-use to interact with the Docker agent. You can ask questions and get help
-Dockerizing your project.
-
-The Docker agent is trained to understand Docker-related questions, and provide
-guidance on Dockerfiles, Docker Compose files, and other Docker assets.
-
-### Editor
-
-To use the extension in your editor or IDE:
-
-1. Open your project in your editor.
-2. Open the Copilot chat interface.
-3. Interact with the Docker agent using the `/docker` or `@docker`, followed by your question.
-
-### GitHub.com
-
-To use the extension in the GitHub web interface:
-
-1. Go to [github.com](https://github.com/) and sign in to your account.
-2. Go to any repository.
-3. Select the Copilot logo in the site menu to open the chat interface.
-
-   ![Copilot chat button](/copilot/copilot-button.png?w=400px)
-
-4. Interact with the Docker agent by tagging `@docker`.
-
-## Example prompts
-
-Here are some examples of the types of questions you can ask the Docker agent:
-
-### Ask general Docker questions
-
-You can ask general question about Docker. For example:
-
-- `@docker what is a Dockerfile`
-- `@docker how do I build a Docker image`
-- `@docker how do I run a Docker container`
-
-### Ask questions about your project
-
-You can ask questions about your project, such as:
-
-- `@docker what is the best way to Dockerize this project`
-- `@docker can you help me find vulnerabilities in my project?`
-
-The Docker agent will analyze your project, generate the necessary files, and,
-if applicable, offer to raise a pull request with the necessary Docker assets.
-
-## Performing actions on your behalf
-
-Before the agent performs any actions on your behalf, such as opening a pull
-request for you, you're prompted to provide your consent to allow the
-operation. You can always roll back or back out of the changes.
-
-![Copilot action prompt](/copilot/copilot-action-prompt.png?w=400px)
-
-In the event that the agent encounters an error, for example during PR
-creation, it handles timeouts and lack of responses gracefully.
-
-## Feedback
-
-For issues or feedback, visit the [GitHub feedback repository](https://github.com/docker/copilot-issues).

content/manuals/copilot/install.md

@@ -0,0 +1,44 @@
+---
+title: Install the extension for your organization
+linkTitle: Install
+description: |
+  Learn how to install the Docker for GitHub Copilot extension for your
+  organization and manage relevant policies to enable seamless integration.
+weight: 10
+---
+
+{{% restricted title="Early Access" %}}
+The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
+{{% /restricted %}}
+
+To use the Docker for GitHub copilot extension, you first need to
+[install](#install) the extension for your organization, and
+[manage](#manage-policies) policies for Copilot in your organization.
+
+## Prerequisites
+
+Before you start, ensure that you're signed in to your GitHub account on
+GitHub.com.
+
+## Install
+
+To install the Docker for GitHub Copilot extension for your GitHub organization:
+
+1. Go to the [Docker for GitHub Copilot](https://github.com/marketplace/docker-for-github-copilot)
+   app in the GitHub Marketplace.
+
+2. Select the **Add** button at the top of the page.
+
+3. Under **Pricing and setup**, select the organization that you want to
+   install the extension for and select **Install it for free**.
+
+4. Select the **Complete order and begin installation** button.
+
+5. Select the repositories where you want to use the Docker Extension for
+   GitHub Copilot and finish with **Install**.
+
+## Manage policies
+
+If you're enabling the extension for a GitHub organization, you also
+need to enable the Copilot Extensions policy. For instructions, see
+[Setting a policy for GitHub Copilot Extensions in your organization](https://docs.github.com/en/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#setting-a-policy-for-github-copilot-extensions-in-your-organization).

content/manuals/copilot/usage.md

@@ -0,0 +1,65 @@
+---
+title: Using the Docker for GitHub Copilot extension
+linkTitle: Usage
+description: |
+  Learn how to use the Docker for GitHub Copilot extension to interact with the
+  Docker agent, get help Dockerizing projects, and ask Docker-related questions
+  directly from your IDE or GitHub.com.
+weight: 20
+---
+
+{{% restricted title="Early Access" %}}
+The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
+{{% /restricted %}}
+
+The Docker Extension for GitHub Copilot provides a chat interface that you can
+use to interact with the Docker agent. You can ask questions and get help
+Dockerizing your project.
+
+The Docker agent is trained to understand Docker-related questions, and provide
+guidance on Dockerfiles, Docker Compose files, and other Docker assets.
+
+## Setup
+
+Before you can start interacting with the Docker agent, make sure you've
+[installed](./install.md) the extension for your organization.
+
+### Enable GitHub Copilot chat in your editor or IDE
+
+For instructions on how to use the Docker Extension for GitHub Copilot in
+your editor, see:
+
+- [Visual Studio Code](https://docs.github.com/en/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=vscode)
+- [Visual Studio](https://docs.github.com/en/copilot/github-copilot-chat/copilot-chat-in-ides/using-github-copilot-chat-in-your-ide?tool=visualstudio)
+- [Codespaces](https://docs.github.com/en/codespaces/reference/using-github-copilot-in-github-codespaces)
+
+### Verify the setup
+
+You can verify that the extension has been properly installed by typing
+`@docker` in the Copilot Chat window. As you type, you should see the Docker
+agent appear in the chat interface.
+
+![Docker agent in chat](images/docker-agent-copilot.png)
+
+The first time you interact with the agent, you're prompted to sign in and
+authorize the Copilot extension with your Docker account.
+
+## Asking Docker questions in your editor
+
+To interact with the Docker agent from within your editor or IDE:
+
+1. Open your project in your editor.
+2. Open the Copilot chat interface.
+3. Interact with the Docker agent by tagging `@docker`, followed by your question.
+
+## Asking Docker questions on GitHub.com
+
+To interact with the Docker agent from the GitHub web interface:
+
+1. Go to [github.com](https://github.com/) and sign in to your account.
+2. Go to any repository.
+3. Select the Copilot logo in the site menu, or select the floating Copilot widget, to open the chat interface.
+
+   ![Copilot chat button](images/copilot-button.png?w=400px)
+
+4. Interact with the Docker agent by tagging `@docker`, followed by your question.

hugo_stats.json

@@ -43,7 +43,6 @@
       "Docker-Hub",
       "Docker-Scout-Dashboard",
       "Download",
-      "Editor-or-IDE",
       "Entra-ID",
       "Entra-ID-SAML-2.0",
       "External-cloud-storage",
@@ -57,7 +56,6 @@
       "Git-Bash",
       "Git-Bash-CLI",
       "GitHub-Actions",
-      "GitHub.com",
       "GitLab",
       "Go",
       "HTTP",