Skip to content

Commit d7078b7

Browse files
committed
copilot: restructure content, editorial improvements
Signed-off-by: David Karlsson <[email protected]>
1 parent c9bb762 commit d7078b7

File tree

9 files changed

+217
-199
lines changed

9 files changed

+217
-199
lines changed

content/manuals/copilot/_index.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: Docker for GitHub Copilot
3+
params:
4+
sidebar:
5+
badge:
6+
color: violet
7+
text: EA
8+
weight: 100
9+
description: Learn how to use the Docker for GitHub Copilot extension to streamline Docker-related tasks.
10+
keywords: Docker, GitHub Copilot, extension, Visual Studio Code, chat, ai, containerization
11+
---
12+
13+
{{% restricted title="Early Access" %}}
14+
The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
15+
{{% /restricted %}}
16+
17+
The [Docker for GitHub Copilot](https://github.com/marketplace/docker-for-github-copilot)
18+
extension integrates Docker's capabilities with GitHub Copilot, providing
19+
assistance with containerizing applications, generating Docker assets, and
20+
analyzing project vulnerabilities. This extension helps you streamline
21+
Docker-related tasks wherever GitHub Copilot Chat is available.
22+
23+
## Key features
24+
25+
Key features of the Docker for GitHub Copilot extension include:
26+
27+
- Ask questions and receive responses about containerization in any context
28+
where GitHub Copilot Chat is available, such as on GitHub.com and in Visual Studio Code.
29+
- Automatically generate Dockerfiles, Docker Compose files, and .dockerignore
30+
files for a project.
31+
- Open pull requests with generated Docker assets directly from the chat
32+
interface.
33+
- Get summaries of project vulnerabilities from [Docker
34+
Scout](/manuals/scout/_index.md) and receive next steps via CLI.
35+
36+
## Data Privacy
37+
38+
The Docker agent is trained exclusively on Docker's documentation and tools to
39+
assist with containerization and related tasks. It does not have access to your
40+
project's data outside the context of the questions you ask.
41+
42+
When using the Docker Extension for GitHub Copilot, GitHub Copilot may include
43+
a reference to the currently open file in its request if authorized by the
44+
user. The Docker agent can read the file to provide context-aware responses.
45+
46+
If the agent is requested to check for vulnerabilities or generate
47+
Docker-related assets, it will clone the referenced repository into in-memory
48+
storage to perform the necessary actions.
49+
50+
Source code, questions, and responses are not persistently stored. The Docker
51+
agent processes data only to provide responses and discards it immediately
52+
afterward.
53+
54+
## Supported languages
55+
56+
The Docker Extension for GitHub Copilot supports the following
57+
programming languages:
58+
59+
- Dockerfile
60+
- Go
61+
- Java
62+
- JavaScript
63+
- Python
64+
- Rust
65+
- TypeScript
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Example prompts for the Docker agent
3+
linkTitle: Example prompts
4+
description: |
5+
Discover example prompts to interact with the Docker agent and learn how to
6+
automate tasks like Dockerizing projects or opening pull requests.
7+
weight: 30
8+
---
9+
10+
{{% restricted title="Early Access" %}}
11+
The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
12+
{{% /restricted %}}
13+
14+
Here are some examples of the types of questions you can ask the Docker agent:
15+
16+
### Ask general Docker questions
17+
18+
You can ask general question about Docker. For example:
19+
20+
- `@docker what is a Dockerfile`
21+
- `@docker how do I build a Docker image`
22+
- `@docker how do I run a Docker container`
23+
24+
### Ask questions about your project
25+
26+
You can ask questions about your project, such as:
27+
28+
- `@docker what is the best way to Dockerize this project`
29+
- `@docker can you help me find vulnerabilities in my project?`
30+
31+
The Docker agent will analyze your project, generate the necessary files, and,
32+
if applicable, offer to raise a pull request with the necessary Docker assets.
33+
34+
## Performing actions on your behalf
35+
36+
Before the agent performs any actions on your behalf, such as opening a pull
37+
request for you, you're prompted to provide your consent to allow the
38+
operation. You can always roll back or back out of the changes.
39+
40+
![Copilot action prompt](images/copilot-action-prompt.png?w=400px)
41+
42+
In the event that the agent encounters an error, for example during PR
43+
creation, it handles timeouts and lack of responses gracefully.
44+
45+
## Feedback
46+
47+
For issues or feedback, visit the [GitHub feedback repository](https://github.com/docker/copilot-issues).

content/manuals/copilot/index.md

Lines changed: 0 additions & 197 deletions
This file was deleted.

content/manuals/copilot/install.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: Install the extension for your organization
3+
linkTitle: Install
4+
description: |
5+
Learn how to install the Docker for GitHub Copilot extension for your
6+
organization and manage relevant policies to enable seamless integration.
7+
weight: 10
8+
---
9+
10+
{{% restricted title="Early Access" %}}
11+
The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
12+
{{% /restricted %}}
13+
14+
To use the Docker for GitHub copilot extension, you first need to
15+
[install](#install) the extension for your organization, and
16+
[manage](#manage-extensions-policy) policies for Copilot in your organization.
17+
18+
## Prerequisites
19+
20+
Before you start, ensure that you're signed in to your GitHub account on
21+
GitHub.com.
22+
23+
## Install
24+
25+
To install the Docker for GitHub Copilot extension for your GitHub organization:
26+
27+
1. Go to the [Docker for GitHub Copilot](https://github.com/marketplace/docker-for-github-copilot)
28+
app in the GitHub Marketplace.
29+
30+
2. Select the **Add** button at the top of the page.
31+
32+
3. Under **Pricing and setup**, select the organization that you want to
33+
install the extension for and select **Install it for free**.
34+
35+
4. Select the **Complete order and begin installation** button.
36+
37+
5. Select the repositories where you want to use the Docker Extension for
38+
GitHub Copilot and finish with **Install**.
39+
40+
## Manage policies
41+
42+
After installing the extension, you need to enable the Copilot Extensions
43+
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).

0 commit comments

Comments
 (0)