diff options
author | Samruddhi Khandale <skhandale@microsoft.com> | 2023-04-14 23:48:25 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-04-14 23:48:25 +0300 |
commit | 2237731474ace274b1756e63937a958131cf719e (patch) | |
tree | 0ba813fb0e58039acea71bdf9f73e1577268d2e0 /src | |
parent | 8d3e9aca9d352a3c4459e321de5d0a0b12062112 (diff) |
Automated documentation update (#521)
Automated documentation update [skip ci]
Co-authored-by: github-actions <github-actions@github.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/aws-cli/README.md | 6 | ||||
-rw-r--r-- | src/azure-cli/README.md | 6 | ||||
-rw-r--r-- | src/docker-in-docker/README.md | 6 | ||||
-rw-r--r-- | src/docker-outside-of-docker/README.md | 6 | ||||
-rw-r--r-- | src/dotnet/README.md | 6 | ||||
-rw-r--r-- | src/go/README.md | 6 | ||||
-rw-r--r-- | src/java/README.md | 6 | ||||
-rw-r--r-- | src/node/README.md | 6 | ||||
-rw-r--r-- | src/php/README.md | 9 | ||||
-rw-r--r-- | src/python/README.md | 7 | ||||
-rw-r--r-- | src/ruby/README.md | 6 | ||||
-rw-r--r-- | src/rust/README.md | 10 | ||||
-rw-r--r-- | src/terraform/README.md | 7 |
13 files changed, 87 insertions, 0 deletions
diff --git a/src/aws-cli/README.md b/src/aws-cli/README.md index 40cc4ae..e45cb3f 100644 --- a/src/aws-cli/README.md +++ b/src/aws-cli/README.md @@ -17,6 +17,12 @@ Installs the AWS CLI along with needed dependencies. Useful for base Dockerfiles |-----|-----|-----|-----| | version | Select or enter an AWS CLI version. | string | latest | +## Customizations + +### VS Code Extensions + +- `AmazonWebServices.aws-toolkit-vscode` + Available versions of the AWS CLI can be found here: https://github.com/aws/aws-cli/blob/v2/CHANGELOG.rst. ## OS Support diff --git a/src/azure-cli/README.md b/src/azure-cli/README.md index cb792d1..4a9de7b 100644 --- a/src/azure-cli/README.md +++ b/src/azure-cli/README.md @@ -19,6 +19,12 @@ Installs the Azure CLI along with needed dependencies. Useful for base Dockerfil | extensions | Optional comma separated list of Azure CLI extensions to install in profile. | string | - | | installBicep | Optionally install Azure Bicep | boolean | false | +## Customizations + +### VS Code Extensions + +- `ms-vscode.azurecli` + ## OS Support diff --git a/src/docker-in-docker/README.md b/src/docker-in-docker/README.md index 9a22c2c..d519a48 100644 --- a/src/docker-in-docker/README.md +++ b/src/docker-in-docker/README.md @@ -22,6 +22,12 @@ Create child containers *inside* a container, independent from the host's docker | dockerDefaultAddressPool | Define default address pools for Docker networks. e.g. base=192.168.0.0/16,size=24 | string | - | | installDockerBuildx | Install Docker Buildx | boolean | true | +## Customizations + +### VS Code Extensions + +- `ms-azuretools.vscode-docker` + ## Limitations This docker-in-docker Dev Container Feature is roughly based on the [official docker-in-docker wrapper script](https://github.com/moby/moby/blob/master/hack/dind) that is part of the [Moby project](https://mobyproject.org/). With this in mind: diff --git a/src/docker-outside-of-docker/README.md b/src/docker-outside-of-docker/README.md index f7f411a..7b558a9 100644 --- a/src/docker-outside-of-docker/README.md +++ b/src/docker-outside-of-docker/README.md @@ -22,6 +22,12 @@ Re-use the host docker socket, adding the Docker CLI to a container. Feature inv | dockerDashComposeVersion | Compose version to use for docker-compose (v1 or v2) | string | v2 | | installDockerBuildx | Install Docker Buildx | boolean | true | +## Customizations + +### VS Code Extensions + +- `ms-azuretools.vscode-docker` + ## Limitations - As the name implies, the Feature is expected to work when the host is running Docker (or the OSS Moby container engine it is built on). It may be possible to get running in other container engines, but it has not been tested with them. diff --git a/src/dotnet/README.md b/src/dotnet/README.md index c13c998..83c4249 100644 --- a/src/dotnet/README.md +++ b/src/dotnet/README.md @@ -19,6 +19,12 @@ Installs the .NET CLI. Provides option of installing sdk or runtime, and option | runtimeOnly | Install just the dotnet runtime if true, and sdk if false. | boolean | false | | installUsingApt | If true, it installs using apt instead of the release URL | boolean | true | +## Customizations + +### VS Code Extensions + +- `ms-dotnettools.csharp` + ## OS Support diff --git a/src/go/README.md b/src/go/README.md index e7a6924..be035ee 100644 --- a/src/go/README.md +++ b/src/go/README.md @@ -18,6 +18,12 @@ Installs Go and common Go utilities. Auto-detects latest version and installs ne | version | Select or enter a Go version to install | string | latest | | golangciLintVersion | Version of golangci-lint to install | string | latest | +## Customizations + +### VS Code Extensions + +- `golang.Go` + ## OS Support diff --git a/src/java/README.md b/src/java/README.md index e74cd5a..1ffd618 100644 --- a/src/java/README.md +++ b/src/java/README.md @@ -24,6 +24,12 @@ Installs Java, SDKMAN! (if not installed), and needed dependencies. | installAnt | Install Ant, a software tool for automating software build processes | boolean | false | | antVersion | Select or enter an Ant version | string | latest | +## Customizations + +### VS Code Extensions + +- `vscjava.vscode-java-pack` + ## License For the Java Feature from this repository, see [NOTICE.txt](https://github.com/devcontainers/features/tree/main/src/java/NOTICE.txt) for licensing information on JDK distributions. diff --git a/src/node/README.md b/src/node/README.md index 877ea58..7a49096 100644 --- a/src/node/README.md +++ b/src/node/README.md @@ -20,6 +20,12 @@ Installs Node.js, nvm, yarn, pnpm, and needed dependencies. | nvmInstallPath | The path where NVM will be installed. | string | /usr/local/share/nvm | | nvmVersion | Version of NVM to install. | string | 0.39.2 | +## Customizations + +### VS Code Extensions + +- `dbaeumer.vscode-eslint` + ## Using nvm from postCreateCommand or another lifecycle command Certain operations like `postCreateCommand` run non-interactive, non-login shells. Unfortunately, `nvm` is really particular that it needs to be "sourced" before it is used, which can only happen automatically with interactive and/or login shells. Fortunately, this is easy to work around: diff --git a/src/php/README.md b/src/php/README.md index 3a9be7a..14f4a17 100644 --- a/src/php/README.md +++ b/src/php/README.md @@ -18,6 +18,15 @@ | version | Select or enter a PHP version | string | latest | | installComposer | Install PHP Composer? | boolean | true | +## Customizations + +### VS Code Extensions + +- `xdebug.php-debug` +- `bmewburn.vscode-intelephense-client` +- `xdebug.php-pack` +- `devsense.phptools-vscode` + ## OS Support diff --git a/src/python/README.md b/src/python/README.md index 0574291..807d89e 100644 --- a/src/python/README.md +++ b/src/python/README.md @@ -22,6 +22,13 @@ Installs the provided version of Python, as well as PIPX, and other common Pytho | installJupyterlab | Install JupyterLab, a web-based interactive development environment for notebooks | boolean | false | | configureJupyterlabAllowOrigin | Configure JupyterLab to accept HTTP requests from the specified origin | string | - | +## Customizations + +### VS Code Extensions + +- `ms-python.python` +- `ms-python.vscode-pylance` + ## OS Support diff --git a/src/ruby/README.md b/src/ruby/README.md index 8a0ff87..8e8ebe2 100644 --- a/src/ruby/README.md +++ b/src/ruby/README.md @@ -17,6 +17,12 @@ Installs Ruby, rvm, rbenv, common Ruby utilities, and needed dependencies. |-----|-----|-----|-----| | version | Select or enter a Ruby version to install | string | latest | +## Customizations + +### VS Code Extensions + +- `rebornix.Ruby` + ## OS Support diff --git a/src/rust/README.md b/src/rust/README.md index 372b56f..f72b56f 100644 --- a/src/rust/README.md +++ b/src/rust/README.md @@ -18,6 +18,16 @@ Installs Rust, common Rust utilities, and their required dependencies | version | Select or enter a version of Rust to install. | string | latest | | profile | Select a rustup install profile. | string | minimal | +## Customizations + +### VS Code Extensions + +- `vadimcn.vscode-lldb` +- `mutantdino.resourcemonitor` +- `rust-lang.rust-analyzer` +- `tamasfe.even-better-toml` +- `serayuzgur.crates` + ## OS Support diff --git a/src/terraform/README.md b/src/terraform/README.md index e75da9b..e930587 100644 --- a/src/terraform/README.md +++ b/src/terraform/README.md @@ -23,6 +23,13 @@ Installs the Terraform CLI and optionally TFLint and Terragrunt. Auto-detects la | installTerraformDocs | Install terraform-docs, a utility to generate documentation from Terraform modules | boolean | false | | httpProxy | Connect to a keyserver using a proxy by configuring this option | string | - | +## Customizations + +### VS Code Extensions + +- `HashiCorp.terraform` +- `ms-azuretools.vscode-azureterraform` + ## OS Support |