Skip to content
This repository has been archived by the owner on Nov 30, 2023. It is now read-only.

Commit

Permalink
Add categories to metadata (#740)
Browse files Browse the repository at this point in the history
  • Loading branch information
Chuxel authored Feb 9, 2021
1 parent 6735f08 commit a9ab215
Show file tree
Hide file tree
Showing 82 changed files with 150 additions and 84 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ A **development container** is a running [Docker](https://www.docker.com) contai

This repository contains a set of **dev container definitions** to help get you up and running with a containerized environment. The definitions describe the appropriate container image, runtime arguments for starting the container, and VS Code extensions that should be installed. Each provides a container configuration file (`devcontainer.json`) and other needed files that you can drop into any existing folder as a starting point for containerizing your project.

> **Note:** While many of these definitions are also expected to work in [GitHub Codespaces](https://github.com/features/codespaces), a few are not yet working. See [here for a list of known issues](containers/CODESPACES.md).
The [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) repositories may also be of interest if you are looking for complete sample projects.

## Adding a definition to a local project
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Dev Container Definition Template - Docker Compose",
"name": "Your Definition Name Here (Community)",

// Update the 'dockerComposeFile' list if you have more compose files or use different names.
"dockerComposeFile": "docker-compose.yml",
Expand Down
23 changes: 12 additions & 11 deletions container-templates/docker-compose/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
# [Name of Definition Here]
# [Name of Definition Here] (Community)

## Summary

_[A short description of the the purpose of the definition goes here.]_

| Metadata | Value |
| --------------------------- | ------------------------------------------------ |
| _Contributors_ | [Your name, email and/or GitHub profile] |
| _Definition type_ | Docker Compose |
| _Works in Codespaces_ | Yes / No |
| _Container host OS support_ | Linux, macOS, Windows |
| _Container OS_ | Debian |
| _Languages, platforms_ | [Languages and platforms the container supports] |
*[A short description of the the purpose of the definition goes here.]*

| Metadata | Value |
|---------------------------- | -----------------------------------------------------------------------------|
| *Contributors* | [Your name, GitHub profile] |
| *Categories* | Community, [Languages, Frameworks, Services, Azure, GCP, AWS, GitHub, Other] |
| *Definition type* | Docker Compose |
| *Works in Codespaces* | Yes / No |
| *Container host OS support* | Linux, macOS, Windows |
| *Container OS* | [OS used by container - e.g. Debian] |
| *Languages, platforms* | [Languages and platforms the container supports] |

## [Optional] Description

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Dev Container Definition Template - Dockerfile",
"name": "Your Definition Name Here (Community)",

// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
"build": {
Expand Down
20 changes: 10 additions & 10 deletions container-templates/dockerfile/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# [Name of Definition Here]
# [Name of Definition Here] (Community)

## Summary

*[A short description of the the purpose of the definition goes here.]*

| Metadata | Value |
| --------------------------- | ------------------------------------------------ |
| *Contributors* | [Your name, email and/or GitHub profile] |
| *Definition type* | Dockerfile |
| *Definition category* | [Base images, Languages, Platforms, Azure, AWS, GCP, DevOps], Community |
| *Works in Codespaces* | Yes / No |
| *Container host OS support* | Linux, macOS, Windows |
| *Container OS* | [OS used by continer - e.g. Debian] |
| *Languages, platforms* | [Languages and platforms the container supports] |
| Metadata | Value |
|---------------------------- | -----------------------------------------------------------------------------|
| *Contributors* | [Your name, GitHub profile] |
| *Categories* | Community, [Languages, Frameworks, Services, Azure, GCP, AWS, GitHub, Other] |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes / No |
| *Container host OS support* | Linux, macOS, Windows |
| *Container OS* | [OS used by continer - e.g. Debian] |
| *Languages, platforms* | [Languages and platforms the container supports] |

## [Optional] Description

Expand Down
2 changes: 1 addition & 1 deletion container-templates/image/.devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Dev Container Definition Template - Container Image",
"name": "Your Definition Name Here (Community)",

// Update the 'image' property with your Docker image name.
"image": "mcr.microsoft.com/vscode/devcontainers/base:debian-10",
Expand Down
23 changes: 12 additions & 11 deletions container-templates/image/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
# [Name of Definition Here]
# [Name of Definition Here] (Community)

## Summary

_[A short description of the the purpose of the definition goes here.]_
*[A short description of the the purpose of the definition goes here.]*

| Metadata | Value |
| --------------------------- | ------------------------------------------------ |
| _Contributors_ | [Your name, email and/or GitHub profile] |
| _Definition type_ | Image |
| _Works in Codespaces_ | Yes / No |
| _Container host OS support_ | Linux, macOS, Windows |
| _Container OS_ | [OS used by container - e.g. Debian] |
| _Languages, platforms_ | [Languages and platforms the container supports] |
| Metadata | Value |
|---------------------------- | -----------------------------------------------------------------------------|
| *Contributors* | [Your name, GitHub profile] |
| *Categories* | Community, [Languages, Frameworks, Services, Azure, GCP, AWS, GitHub, Other] |
| *Definition type* | Image |
| *Works in Codespaces* | Yes / No |
| *Container host OS support* | Linux, macOS, Windows |
| *Container OS* | [OS used by container - e.g. Debian] |
| *Languages, platforms* | [Languages and platforms the container supports] |

## [Optional] Description

Expand Down Expand Up @@ -57,4 +58,4 @@ This definition includes some test code that will help you verify it is working

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).
Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE).
1 change: 0 additions & 1 deletion containers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,3 @@ See [CONTRIBUTING.md](../CONTRIBUTING.md) for details on contributing to this re
Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License. See [LICENSE](https://github.com/Microsoft/vscode-dev-containers/blob/master/LICENSE)

3 changes: 2 additions & 1 deletion containers/alpine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Categories* | Core, Other |
| *Definition type* | Dockerfile |
| *Published images* | mcr.microsoft.com/vscode/devcontainers/base:alpine |
| *Available image variants* | 3.10, 3.11, 3.12 ([full list](https://mcr.microsoft.com/v2/vscode/devcontainers/base/tags/list)) |
| *Published image architecture(s)* | x86-64 |
| *Works in Codespaces* | No ([#458](https://github.com/MicrosoftDocs/vsonline/issues/458)) |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
| *Container OS* | Alpine Linux |
| *Languages, platforms* | Any |
Expand Down
3 changes: 2 additions & 1 deletion containers/azure-ansible/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Azure Ansible
# Azure Ansible (Community)

## Summary

Expand All @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | [Carlos Mendible](https://github.com/cmendible) |
| *Categories* | Community, Azure, Other |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
3 changes: 2 additions & 1 deletion containers/azure-bicep/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Azure Bicep
# Azure Bicep (Community)

## Summary

Expand All @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | [Carlos Mendible](https://github.com/cmendible) |
| *Categories* | Community, Services, Azure |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
3 changes: 2 additions & 1 deletion containers/azure-blockchain/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Azure Blockchain
# Azure Blockchain (Community)

## Summary

Expand All @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | [Carlos Mendible](https://github.com/cmendible) |
| *Categories* | Community, Services, Azure |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
1 change: 1 addition & 0 deletions containers/azure-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Azure Functions & C# (.NET Core 2.1)",
"name": "Azure Functions & C# - .NET Core 2.1",
"dockerFile": "Dockerfile",
"forwardPorts": [ 7071 ],

Expand Down
5 changes: 3 additions & 2 deletions containers/azure-functions-dotnetcore-2.1/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Azure Functions & C# (.NET Core 2.1)
# Azure Functions & C# - .NET Core 2.1

## Summary

*Develop Azure Functions in C#. Includes NET Core 2.1, the Azure Functions SDK, and related extensions and dependencies.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Contributors* | The Azure Functions Team, @brandonh-msft |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "Azure Functions & C# (.NET Core 3.1)",
"name": "Azure Functions & C# - .NET Core 3.1",
"dockerFile": "Dockerfile",
"forwardPorts": [ 7071 ],

Expand Down
5 changes: 3 additions & 2 deletions containers/azure-functions-dotnetcore-3.1/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Azure Functions & C# (.NET Core 3.1)
# Azure Functions & C# - .NET Core 3.1

## Summary

*Develop Azure Functions in C#. Includes NET Core 3.1, the Azure Functions SDK, and related extensions and dependencies.*

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team, brandonh-msft |
| *Contributors* | The Azure Functions Team, @brandonh-msft |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
3 changes: 2 additions & 1 deletion containers/azure-functions-java-11/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Java Team |
| *Contributors* | The Azure Functions Team |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
3 changes: 2 additions & 1 deletion containers/azure-functions-java-8/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Java Team |
| *Contributors* | The Azure Functions Team |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
1 change: 1 addition & 0 deletions containers/azure-functions-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | The Azure Functions Team |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Published images* | mcr.microsoft.com/azure-functions/node |
| *Available image variants* | 10, 12 |
Expand Down
3 changes: 2 additions & 1 deletion containers/azure-functions-pwsh/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

| Metadata | Value |
|----------|-------|
| *Contributors* | [brettmillerb](https://github.com/brettmillerb) |
| *Contributors* | The Azure Functions Team, [@brettmillerb](https://github.com/brettmillerb) |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Published images* | mcr.microsoft.com/azure-functions/powershell |
| *Available image variants* | 6, 7 |
Expand Down
3 changes: 2 additions & 1 deletion containers/azure-functions-python-3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

| Metadata | Value |
|----------|-------|
| *Contributors* | [Anthony Chu](https://github.com/anthonychu) |
| *Contributors* | The Azure Functions Team, [Anthony Chu](https://github.com/anthonychu) |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
1 change: 1 addition & 0 deletions containers/azure-machine-learning-python-3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
1 change: 1 addition & 0 deletions containers/azure-static-web-apps/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | The Azure Functions Team & [email protected] |
| *Categories* | Services, Azure |
| *Definition type* | Dockerfile |
| *Published image architecture(s)* | x86-64 |
| *Works in Codespaces* | Yes |
Expand Down
3 changes: 2 additions & 1 deletion containers/azure-terraform/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Azure Terraform
# Azure Terraform (Community)

## Summary

Expand All @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | [Carlos Mendible](https://github.com/cmendible) |
| *Categories* | Community, Azure, Other |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
3 changes: 2 additions & 1 deletion containers/bash/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Bash
# Bash (Community)

## Summary

Expand All @@ -7,6 +7,7 @@
| Metadata | Value |
| --------------------------- | -------------------------------------------- |
| *Contributors* | [Aaryn Smith](https://gitlab.com/aarynsmith) |
| *Categories* | Community, Languages |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
3 changes: 2 additions & 1 deletion containers/bazel/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Bazel
# Bazel (Community)

## Summary

Expand All @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | William Phetsinorath <[email protected]> |
| *Categories* | Community, Other |
| *Definition type* | Dockerfile |
| *Works in Codespaces* | Yes |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
3 changes: 2 additions & 1 deletion containers/codespaces-linux-stretch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

| Metadata | Value |
|----------|-------|
| *Contributors* | The GitHub Codespaces and VS Code teams |
| *Contributors* | The GitHub Codespaces team |
| *Categories* | Services, GitHub |
| *Definition type* | Dockerfile |
| *Published image* | mcr.microsoft.com/vscode/devcontainers/universal:0-stretch<br />mcr.microsoft.com/vscode/devcontainers/universal:0-linux |
| *Published image architecture(s)* | x86-64 |
Expand Down
3 changes: 2 additions & 1 deletion containers/codespaces-linux/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

| Metadata | Value |
|----------|-------|
| *Contributors* | The GitHub Codespaces and VS Code teams |
| *Contributors* | The GitHub Codespaces team |
| *Categories* | Services, GitHub |
| *Definition type* | Dockerfile |
| *Published image* | mcr.microsoft.com/vscode/devcontainers/universal:linux<br />mcr.microsoft.com/vscode/devcontainers/universal:focal |
| *Published image architecture(s)* | x86-64 |
Expand Down
1 change: 1 addition & 0 deletions containers/cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | The VS Code Team |
| *Categories* | Core, Languages |
| *Definition type* | Dockerfile |
| *Published images* | mcr.microsoft.com/vscode/devcontainers/cpp |
| *Available image variants* | stretch, buster, bionic, focal ([full list](https://mcr.microsoft.com/v2/vscode/devcontainers/cpp/tags/list)) |
Expand Down
3 changes: 2 additions & 1 deletion containers/dapr-dotnetcore-3.1/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Dapr with C# (.NET Core 3.1)
# Dapr with C# (Community)

## Summary

Expand All @@ -7,6 +7,7 @@
| Metadata | Value |
|----------|-------|
| *Contributors* | The Visual Studio Container Tools team |
| *Categories* | Community, Frameworks |
| *Definition type* | Docker Compose |
| *Works in Codespaces* | No |
| *Container host OS support* | Linux, macOS, Windows |
Expand Down
Loading

0 comments on commit a9ab215

Please sign in to comment.