diff options
author | Devcontainers CI <vscr-feedback@microsoft.com> | 2022-06-21 23:14:53 +0300 |
---|---|---|
committer | Devcontainers CI <vscr-feedback@microsoft.com> | 2022-06-21 23:14:53 +0300 |
commit | 2a51a0164c89a589c16c764d884773e08093429f (patch) | |
tree | ac510b0df8eac023715722b443962a417c252236 | |
parent | 3b6fe6e60843e5b9d77b6d97e9240910cd38c45b (diff) |
Automated documentation update
-rw-r--r-- | src/aws-cli/README.md | 2 | ||||
-rw-r--r-- | src/azure-cli/README.md | 2 | ||||
-rw-r--r-- | src/common/README.md | 4 | ||||
-rw-r--r-- | src/desktop-lite/README.md | 4 | ||||
-rw-r--r-- | src/docker-from-docker/README.md | 2 | ||||
-rw-r--r-- | src/docker-in-docker/README.md | 4 | ||||
-rw-r--r-- | src/dotnet/README.md | 2 | ||||
-rw-r--r-- | src/git-lfs/README.md | 2 | ||||
-rw-r--r-- | src/git/README.md | 4 | ||||
-rw-r--r-- | src/github-cli/README.md | 2 | ||||
-rw-r--r-- | src/go/README.md | 2 | ||||
-rw-r--r-- | src/java/README.md | 2 | ||||
-rw-r--r-- | src/kubectl-helm-minikube/README.md | 2 | ||||
-rw-r--r-- | src/node/README.md | 2 | ||||
-rw-r--r-- | src/oryx/README.md | 2 | ||||
-rw-r--r-- | src/powershell/README.md | 2 | ||||
-rw-r--r-- | src/python/README.md | 4 | ||||
-rw-r--r-- | src/ruby/README.md | 2 | ||||
-rw-r--r-- | src/rust/README.md | 2 | ||||
-rw-r--r-- | src/sshd/README.md | 2 | ||||
-rw-r--r-- | src/terraform/README.md | 2 |
21 files changed, 26 insertions, 26 deletions
diff --git a/src/aws-cli/README.md b/src/aws-cli/README.md index 7c8ed86..6a64379 100644 --- a/src/aws-cli/README.md +++ b/src/aws-cli/README.md @@ -1,7 +1,7 @@ # AWS CLI (aws-cli) - +Installs the AWS CLI along with needed dependencies. Useful for base Dockerfiles that often are missing required install dependencies like gpg. ## Example Usage diff --git a/src/azure-cli/README.md b/src/azure-cli/README.md index 515a86b..09150e2 100644 --- a/src/azure-cli/README.md +++ b/src/azure-cli/README.md @@ -1,7 +1,7 @@ # Azure CLI (azure-cli) - +Installs the Azure CLI along with needed dependencies. Useful for base Dockerfiles that often are missing required install dependencies like gpg. ## Example Usage diff --git a/src/common/README.md b/src/common/README.md index ba27a5f..c7bc31c 100644 --- a/src/common/README.md +++ b/src/common/README.md @@ -1,7 +1,7 @@ -# common (common) +# Common Debian (common) -common +Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-root user. ## Example Usage diff --git a/src/desktop-lite/README.md b/src/desktop-lite/README.md index af357b7..55b623d 100644 --- a/src/desktop-lite/README.md +++ b/src/desktop-lite/README.md @@ -1,7 +1,7 @@ -# Light-weight desktop (Fluxbox) (desktop-lite) - +# Light-weight Desktop (desktop-lite) +Adds a lightweight Fluxbox based desktop to the container that can be accessed using a VNC viewer or the web. GUI-based commands executed from the built-in VS code terminal will open on the desktop automatically. ## Example Usage diff --git a/src/docker-from-docker/README.md b/src/docker-from-docker/README.md index 8235273..c9ad5e2 100644 --- a/src/docker-from-docker/README.md +++ b/src/docker-from-docker/README.md @@ -1,5 +1,5 @@ -# Docker (Moby) support, reuse host Docker Engine (Docker-from-Docker) (docker-from-docker) +# Docker (Docker-from-Docker) (docker-from-docker) diff --git a/src/docker-in-docker/README.md b/src/docker-in-docker/README.md index 94bad80..c3abfa7 100644 --- a/src/docker-in-docker/README.md +++ b/src/docker-in-docker/README.md @@ -1,7 +1,7 @@ -# Docker (Moby) support (Docker-in-Docker) (docker-in-docker) - +# Docker (Docker-in-Docker) (docker-in-docker) +Create child containers *inside* a container, independent from the host's docker instance. Installs Docker extension in the container along with needed CLIs. ## Example Usage diff --git a/src/dotnet/README.md b/src/dotnet/README.md index 9f6ae24..cce0df5 100644 --- a/src/dotnet/README.md +++ b/src/dotnet/README.md @@ -1,7 +1,7 @@ # Dotnet CLI (dotnet) - +Installs the .NET CLI. Provides option of installing sdk or runtime, and option of versions to install. Uses latest version of .NET sdk as defaults to install. ## Example Usage diff --git a/src/git-lfs/README.md b/src/git-lfs/README.md index 3b462c4..3b799d6 100644 --- a/src/git-lfs/README.md +++ b/src/git-lfs/README.md @@ -1,7 +1,7 @@ # Git Large File Support (LFS) (git-lfs) - +Installs Git Large File Support (Git LFS) along with needed dependencies. Useful for base Dockerfiles that often are missing required install dependencies like git and curl. ## Example Usage diff --git a/src/git/README.md b/src/git/README.md index 101d97c..6f637b9 100644 --- a/src/git/README.md +++ b/src/git/README.md @@ -1,7 +1,7 @@ -# Git (may require compilation) (git) - +# Git (from source) (git) +Install an up-to-date version of Git, built from source as needed. Useful for when you want the latest and greatest features. Auto-detects latest stable version and installs needed dependencies. ## Example Usage diff --git a/src/github-cli/README.md b/src/github-cli/README.md index feb3a5b..5192bba 100644 --- a/src/github-cli/README.md +++ b/src/github-cli/README.md @@ -1,7 +1,7 @@ # GitHub CLI (github-cli) - +Installs the GitHub CLI. Auto-detects latest version and installs needed dependencies. ## Example Usage diff --git a/src/go/README.md b/src/go/README.md index 5183633..6f02ca4 100644 --- a/src/go/README.md +++ b/src/go/README.md @@ -1,7 +1,7 @@ # Go (go) - +Installs Go and common Go utilities. Auto-detects latest version and installs needed dependencies. ## Example Usage diff --git a/src/java/README.md b/src/java/README.md index 8a58b53..8d9e444 100644 --- a/src/java/README.md +++ b/src/java/README.md @@ -1,7 +1,7 @@ # Java (via SDKMAN!) (java) - +Installs Java, SDKMAN! (if not installed), and needed dependencies. ## Example Usage diff --git a/src/kubectl-helm-minikube/README.md b/src/kubectl-helm-minikube/README.md index eaaf4ed..5ba2294 100644 --- a/src/kubectl-helm-minikube/README.md +++ b/src/kubectl-helm-minikube/README.md @@ -1,7 +1,7 @@ # Kubectl, Helm, and Minkube (kubectl-helm-minikube) - +Installs latest version of kubectl, Helm, and optionally minikube. Auto-detects latest versions and installs needed dependencies. ## Example Usage diff --git a/src/node/README.md b/src/node/README.md index 45325f6..73d314c 100644 --- a/src/node/README.md +++ b/src/node/README.md @@ -1,7 +1,7 @@ # Node.js (via nvm) and yarn (node) - +Installs Node.js, nvm, yarn, and needed dependencies. ## Example Usage diff --git a/src/oryx/README.md b/src/oryx/README.md index 6f15882..a15c114 100644 --- a/src/oryx/README.md +++ b/src/oryx/README.md @@ -1,7 +1,7 @@ # Oryx (oryx) - +Installs the oryx CLI ## Example Usage diff --git a/src/powershell/README.md b/src/powershell/README.md index c2f4d59..21372ff 100644 --- a/src/powershell/README.md +++ b/src/powershell/README.md @@ -1,7 +1,7 @@ # PowerShell (powershell) - +Installs PowerShell along with needed dependencies. Useful for base Dockerfiles that often are missing required install dependencies like gpg. ## Example Usage diff --git a/src/python/README.md b/src/python/README.md index 3af1ac8..793e428 100644 --- a/src/python/README.md +++ b/src/python/README.md @@ -1,7 +1,7 @@ -# Python (may require compilation) (python) +# Python (python) -Python (may require compilation) +Installs the provided version of Python, as well as PIPX, and other common Python utilities. JupyterLab is conditionally installed with the python feature. Note: May require source code compilation. ## Example Usage diff --git a/src/ruby/README.md b/src/ruby/README.md index 28eefa2..55268f0 100644 --- a/src/ruby/README.md +++ b/src/ruby/README.md @@ -1,7 +1,7 @@ # Ruby (via rvm) (ruby) - +Installs Ruby, rvm, rbenv, common Ruby utilities, and needed dependencies. ## Example Usage diff --git a/src/rust/README.md b/src/rust/README.md index 9bc7634..24a2348 100644 --- a/src/rust/README.md +++ b/src/rust/README.md @@ -1,7 +1,7 @@ # Rust (rust) - +Installs Rust, common Rust utilities, and their required dependencies ## Example Usage diff --git a/src/sshd/README.md b/src/sshd/README.md index 1355911..838cda7 100644 --- a/src/sshd/README.md +++ b/src/sshd/README.md @@ -1,7 +1,7 @@ # SSH server (sshd) - +Adds a SSH server into a container so that you can use an external terminal, sftp, or SSHFS to interact with it. ## Example Usage diff --git a/src/terraform/README.md b/src/terraform/README.md index 866bed8..cd6bb67 100644 --- a/src/terraform/README.md +++ b/src/terraform/README.md @@ -1,7 +1,7 @@ # Terraform, tflint, and TFGrunt (terraform) - +Installs the Terraform CLI and optionally TFLint and Terragrunt. Auto-detects latest version and installs needed dependencies. ## Example Usage |