Skip to content

Commit 3dfef8a

Browse files
authored
Updates for Container Tools extension (#257)
1 parent a7f8771 commit 3dfef8a

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Extensibility Packages for Docker extension for VS Code
2-
This repository contains several extensibility packages for the Docker extension for VS Code.
1+
## Extensibility Packages for Container Tools extension for VS Code
2+
This repository contains several extensibility packages for the Container Tools extension for VS Code.
33

44
### [vscode-container-client](https://github.com/microsoft/vscode-docker-extensibility/tree/main/packages/vscode-container-client)
5-
Library support for multiple Docker container runtimes.
5+
Library support for multiple container runtimes.
66

77
### [vscode-docker-registries](https://github.com/microsoft/vscode-docker-extensibility/tree/main/packages/vscode-docker-registries)
88
Unified container registry provider model.

packages/vscode-container-client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# vscode-container-client
22

33
## Overview
4-
This package adds support for various Docker container runtimes, abstracting away the details of the runtime and the way it is called, to provide a common interface for any Docker runtime (e.g. Docker in WSL, Docker Engine, Docker Desktop, etc.).
4+
This package adds support for various container runtimes, abstracting away the details of the runtime and the way it is called, to provide a common interface for any container runtime (e.g. Docker in WSL, Docker Engine, Docker Desktop, Podman, etc.).
55

66
## Usage
77
Each of the runtime clients provide a command line to execute and a function to parse the output, for each relevant operation. These items are combined into a `CommandResponse` object. In addition, many helpful utility classes are provided, for building command lines, running the commands, and a handful of other scenarios.

packages/vscode-docker-registries/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Docker for Visual Studio Code: Extensibility Model
1+
# Container Tools for Visual Studio Code: Extensibility Model
22

33
## Overview
4-
This package provides the necessary interfaces to implement a registry provider for the [Docker extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) for Visual Studio Code. Additionally, it also contains an implementation of a registry provider for the common [Docker Registry HTTP API V2](https://docs.docker.com/registry/spec/api/). Most implementations will be a fairly slim inheriting implementation of this.
4+
This package provides the necessary interfaces to implement a registry provider for the [Container Tools extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-containers) for Visual Studio Code. Additionally, it also contains an implementation of a registry provider for the common [Docker Registry HTTP API V2](https://docs.docker.com/registry/spec/api/). Most implementations will be a fairly slim inheriting implementation of this.
55

6-
In order to implement a provider, you must create a VS Code extension which will activate when the Docker explorer view is opened, and register itself with the Docker extension. The Docker extension will call into your provider to discover what nodes to show in the explorer view.
6+
In order to implement a provider, you must create a VS Code extension which will activate when the Container Explorer view is opened, and register itself with the Container Tools extension. The Container Tools extension will call into your provider to discover what nodes to show in the explorer view.
77

88
## When to implement a registry provider extension
99
You should implement a registry provider extension if:
@@ -18,9 +18,9 @@ You should _not_ implement a registry provider extension if:
1818

1919
## How to implement a registry provider extension
2020
1. Create a new VS Code extension. [Learn more](https://code.visualstudio.com/api/get-started/your-first-extension)
21-
1. Add the following activation event to your extension's package.json: `onCommand:vscode-docker.activateRegistryProviders`. [Learn more](https://code.visualstudio.com/api/references/activation-events)
21+
1. Add the following activation event to your extension's package.json: `onCommand:vscode-containers.activateRegistryProviders`. [Learn more](https://code.visualstudio.com/api/references/activation-events)
2222
1. Implement the [`RegistryDataProvider`](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/contracts/RegistryDataProvider.ts) interface. The easiest way to do this is to extend either [`CommonRegistryDataProvider`](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/clients/Common/CommonRegistryDataProvider.ts) or, if your registry is compliant to the V2 registry spec, [`RegistryV2DataProvider`](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/clients/RegistryV2/RegistryV2DataProvider.ts).
23-
1. In your extension's `activate()` method, call into the Docker extension to register your provider. [Learn more](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/contracts/DockerExtension.ts)
23+
1. In your extension's `activate()` method, call into the Container Tools extension to register your provider. [Learn more](https://github.com/microsoft/vscode-docker-extensibility/blob/main/packages/vscode-docker-registries/src/contracts/DockerExtension.ts)
2424

2525
## License
2626
[MIT](LICENSE)

packages/vscode-docker-registries/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "@microsoft/vscode-docker-registries",
33
"author": "Microsoft Corporation",
44
"version": "0.2.0",
5-
"description": "Extensibility model for contributing registry providers to the Docker extension for Visual Studio Code",
5+
"description": "Extensibility model for contributing registry providers to the Container Tools extension for Visual Studio Code",
66
"license": "See LICENSE in the project root for license information.",
77
"repository": {
88
"type": "git",

0 commit comments

Comments
 (0)