aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJosh Spicer <joshspicer@github.com>2022-06-14 03:01:19 +0300
committerGitHub <noreply@github.com>2022-06-14 03:01:19 +0300
commit2fa323248528604a3548fd1292c74c7b473c611b (patch)
tree39831944b1ed879a3342310b6f2a107e48153aad /src
parentfac5e5a4540ffc79138b94ce8edfd329a209b250 (diff)
Devcontainer docs (#47)
* docs * automatically generate documentation from features.json * trigger doc gen * 1 * no-ci * no-ci * no-ci * no-ci * comment out pull * Automated documentation update * no-ci markdown table * Automated documentation update * no-ci * Automated documentation update * branch to main Co-authored-by: Devcontainers CI <vscr-feedback@microsoft.com>
Diffstat (limited to 'src')
-rw-r--r--src/anaconda/README.md27
-rw-r--r--src/aws-cli/README.md27
-rw-r--r--src/azure-cli/README.md27
-rw-r--r--src/common/README.md33
-rw-r--r--src/desktop-lite/README.md31
-rw-r--r--src/docker-from-docker/README.md29
-rw-r--r--src/docker-in-docker/README.md29
-rw-r--r--src/dotnet/README.md30
-rw-r--r--src/git-lfs/README.md27
-rw-r--r--src/git/README.md28
-rw-r--r--src/github-cli/README.md27
-rw-r--r--src/go/README.md27
-rw-r--r--src/hugo/README.md27
-rw-r--r--src/java/README.md27
-rw-r--r--src/kubectl-helm-minikube/README.md29
-rw-r--r--src/node/README.md29
-rw-r--r--src/oryx/README.md25
-rw-r--r--src/php/README.md29
-rw-r--r--src/powershell/README.md27
-rw-r--r--src/python/README.md33
-rw-r--r--src/ruby/README.md27
-rw-r--r--src/rust/README.md28
-rw-r--r--src/sshd/README.md27
-rw-r--r--src/terraform/README.md29
-rw-r--r--src/terraform/devcontainer-feature.json2
25 files changed, 680 insertions, 1 deletions
diff --git a/src/anaconda/README.md b/src/anaconda/README.md
new file mode 100644
index 0000000..4145d90
--- /dev/null
+++ b/src/anaconda/README.md
@@ -0,0 +1,27 @@
+
+# Anaconda (anaconda)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/anaconda@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter an anaconda version. | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/aws-cli/README.md b/src/aws-cli/README.md
new file mode 100644
index 0000000..7c8ed86
--- /dev/null
+++ b/src/aws-cli/README.md
@@ -0,0 +1,27 @@
+
+# AWS CLI (aws-cli)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/aws-cli@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter an AWS CLI version. (Available versions here: https://github.com/aws/aws-cli/blob/v2/CHANGELOG.rst) | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/azure-cli/README.md b/src/azure-cli/README.md
new file mode 100644
index 0000000..515a86b
--- /dev/null
+++ b/src/azure-cli/README.md
@@ -0,0 +1,27 @@
+
+# Azure CLI (azure-cli)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/azure-cli@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter an Azure CLI version. (Available versions may vary by Linux distribution.) | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/common/README.md b/src/common/README.md
new file mode 100644
index 0000000..ba27a5f
--- /dev/null
+++ b/src/common/README.md
@@ -0,0 +1,33 @@
+
+# common (common)
+
+common
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/common@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| install_Zsh | Install ZSH? | boolean | true |
+| install_Oh_My_Zsh | Install Oh My Zsh!? | boolean | true |
+| upgrade_packages | Upgrade OS packages? | boolean | true |
+| username | Enter name of non-root user to configure or none to skip | string | automatic |
+| user_uid | Enter uid for non-root user | string | automatic |
+| user_gid | Enter gid for non-root user | string | automatic |
+| add_non_free_packages | Add packages from non-free Debian repository? | boolean | - |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/desktop-lite/README.md b/src/desktop-lite/README.md
new file mode 100644
index 0000000..af357b7
--- /dev/null
+++ b/src/desktop-lite/README.md
@@ -0,0 +1,31 @@
+
+# Light-weight desktop (Fluxbox) (desktop-lite)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/desktop-lite@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Currently Unused! | string | latest |
+| novnc_version | NoVnc Version | string | 1.2.0 |
+| vnc_password | Enter a password for desktop connections | string | vscode |
+| novnc_port | Enter a port for the VNC web client | string | 6080 |
+| vnc_port | Enter a port for the desktop VNC server | string | 5901 |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/docker-from-docker/README.md b/src/docker-from-docker/README.md
new file mode 100644
index 0000000..8235273
--- /dev/null
+++ b/src/docker-from-docker/README.md
@@ -0,0 +1,29 @@
+
+# Docker (Moby) support, reuse host Docker Engine (Docker-from-Docker) (docker-from-docker)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/docker-from-docker@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a Docker/Moby CLI version. (Availability can vary by OS version.) | string | latest |
+| moby | Install OSS Moby build instead of Docker CE | boolean | true |
+| docker_dash_compose_version | Compose version to use for docker-compose (v1 or v2) | string | v1 |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/docker-in-docker/README.md b/src/docker-in-docker/README.md
new file mode 100644
index 0000000..94bad80
--- /dev/null
+++ b/src/docker-in-docker/README.md
@@ -0,0 +1,29 @@
+
+# Docker (Moby) support (Docker-in-Docker) (docker-in-docker)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/docker-in-docker@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a Docker/Moby Engine version. (Availability can vary by OS version.) | string | latest |
+| moby | Install OSS Moby build instead of Docker CE | boolean | true |
+| docker_dash_compose_version | Default version of Docker Compose (v1 or v2) | string | v1 |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/dotnet/README.md b/src/dotnet/README.md
new file mode 100644
index 0000000..9f6ae24
--- /dev/null
+++ b/src/dotnet/README.md
@@ -0,0 +1,30 @@
+
+# Dotnet CLI (dotnet)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/dotnet@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a dotnet CLI version. (Available versions may vary by Linux distribution.) | string | latest |
+| runtime_only | Install just the dotnet runtime if true, and sdk if false. | boolean | - |
+| override_default_version | If true, overrides existing version (if any) of dotnet on the PATH | boolean | true |
+| install_using_apt | If true, it installs using apt instead of the release URL | boolean | true |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/git-lfs/README.md b/src/git-lfs/README.md
new file mode 100644
index 0000000..3b462c4
--- /dev/null
+++ b/src/git-lfs/README.md
@@ -0,0 +1,27 @@
+
+# Git Large File Support (LFS) (git-lfs)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/git-lfs@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select version of Git LFS to install | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/git/README.md b/src/git/README.md
new file mode 100644
index 0000000..101d97c
--- /dev/null
+++ b/src/git/README.md
@@ -0,0 +1,28 @@
+
+# Git (may require compilation) (git)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/git@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a Git version. | string | os-provided |
+| ppa | Install from PPA if available | boolean | true |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/github-cli/README.md b/src/github-cli/README.md
new file mode 100644
index 0000000..feb3a5b
--- /dev/null
+++ b/src/github-cli/README.md
@@ -0,0 +1,27 @@
+
+# GitHub CLI (github-cli)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/github-cli@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select version of the GitHub CLI, if not latest. | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/go/README.md b/src/go/README.md
new file mode 100644
index 0000000..5183633
--- /dev/null
+++ b/src/go/README.md
@@ -0,0 +1,27 @@
+
+# Go (go)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/go@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a Go version to install | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/hugo/README.md b/src/hugo/README.md
new file mode 100644
index 0000000..18aae05
--- /dev/null
+++ b/src/hugo/README.md
@@ -0,0 +1,27 @@
+
+# Hugo (hugo)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/hugo@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a version. | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/java/README.md b/src/java/README.md
new file mode 100644
index 0000000..8a58b53
--- /dev/null
+++ b/src/java/README.md
@@ -0,0 +1,27 @@
+
+# Java (via SDKMAN!) (java)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/java@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a Java version to install | string | lts |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/kubectl-helm-minikube/README.md b/src/kubectl-helm-minikube/README.md
new file mode 100644
index 0000000..eaaf4ed
--- /dev/null
+++ b/src/kubectl-helm-minikube/README.md
@@ -0,0 +1,29 @@
+
+# Kubectl, Helm, and Minkube (kubectl-helm-minikube)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/kubectl-helm-minikube@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a Kubernetes version to install | string | latest |
+| helm | Select or enter a Helm version to install | string | latest |
+| minikube | Select or enter a Minikube version to install | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/node/README.md b/src/node/README.md
new file mode 100644
index 0000000..45325f6
--- /dev/null
+++ b/src/node/README.md
@@ -0,0 +1,29 @@
+
+# Node.js (via nvm) and yarn (node)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/node@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a Node.js version to install | string | lts |
+| install_tools_for_node_gyp | Install dependencies to compile native node modules (node-gyp)? | boolean | true |
+| nvm_install_path | The path where NVM will be installed. | string | /usr/local/share/nvm |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/oryx/README.md b/src/oryx/README.md
new file mode 100644
index 0000000..6f15882
--- /dev/null
+++ b/src/oryx/README.md
@@ -0,0 +1,25 @@
+
+# Oryx (oryx)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/oryx@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/php/README.md b/src/php/README.md
new file mode 100644
index 0000000..bcc5253
--- /dev/null
+++ b/src/php/README.md
@@ -0,0 +1,29 @@
+
+# PHP (php)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/php@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a PHP version | string | latest |
+| install_composer | Install PHP Composer? | boolean | true |
+| override_default_version | If true, overrides existing version (if any) of dotnet on the PATH | boolean | true |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/powershell/README.md b/src/powershell/README.md
new file mode 100644
index 0000000..c2f4d59
--- /dev/null
+++ b/src/powershell/README.md
@@ -0,0 +1,27 @@
+
+# PowerShell (powershell)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/powershell@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a version of PowerShell. | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/python/README.md b/src/python/README.md
new file mode 100644
index 0000000..3af1ac8
--- /dev/null
+++ b/src/python/README.md
@@ -0,0 +1,33 @@
+
+# Python (may require compilation) (python)
+
+Python (may require compilation)
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/python@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select a Python version to install. | string | os-provided |
+| install_python_tools | Install common Python tools like pylint | boolean | true |
+| optimize | Optimize Python for performance when compiled (slow) | boolean | - |
+| installPath | The path where python will be installed. | string | /usr/local/python |
+| override_default_version | If true, overrides existing version (if any) of python on the PATH | boolean | true |
+| install_jupyterlab | Install JupyterLab, a web-based interactive development environment for notebooks | boolean | - |
+| configure_jupyterlab_allow_origin | Configure JupyterLab to accept HTTP requests from the specified origin | string | - |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/ruby/README.md b/src/ruby/README.md
new file mode 100644
index 0000000..28eefa2
--- /dev/null
+++ b/src/ruby/README.md
@@ -0,0 +1,27 @@
+
+# Ruby (via rvm) (ruby)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/ruby@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a Ruby version to install | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/rust/README.md b/src/rust/README.md
new file mode 100644
index 0000000..9bc7634
--- /dev/null
+++ b/src/rust/README.md
@@ -0,0 +1,28 @@
+
+# Rust (rust)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/rust@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Select or enter a version of Rust to install. | string | latest |
+| profile | Select a rustup install profile. | string | minimal |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/sshd/README.md b/src/sshd/README.md
new file mode 100644
index 0000000..1355911
--- /dev/null
+++ b/src/sshd/README.md
@@ -0,0 +1,27 @@
+
+# SSH server (sshd)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/sshd@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Currently unused. | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/terraform/README.md b/src/terraform/README.md
new file mode 100644
index 0000000..866bed8
--- /dev/null
+++ b/src/terraform/README.md
@@ -0,0 +1,29 @@
+
+# Terraform, tflint, and TFGrunt (terraform)
+
+
+
+## Example Usage
+
+```json
+"features": [
+ {
+ "id": "devcontainers/features/terraform@latest",
+ "options": {
+ "version": "latest"
+ }
+ }
+]
+```
+
+## Options
+
+| Options Id | Description | Type | Default Value |
+|-----|-----|-----|-----|
+| version | Terraform version | string | latest |
+| tflint | Tflint version | string | latest |
+| terragrunt | Terragrunt version | string | latest |
+
+---
+
+_Note: This file was auto-generated from the [devcontainer-feature.json](./devcontainer-feature.json)._
diff --git a/src/terraform/devcontainer-feature.json b/src/terraform/devcontainer-feature.json
index 8af83a7..c999cae 100644
--- a/src/terraform/devcontainer-feature.json
+++ b/src/terraform/devcontainer-feature.json
@@ -40,7 +40,7 @@
"enabled": true,
"args": []
},
- "azureTerraform.terminal": "integrated",
+ "azureTerraform.terminal": "integrated"
},
"install": {
"app": "",