microsoft
/
vscode-dev-containers
зеркало из https://github.com/microsoft/vscode-dev-containers.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Improve script docs to improve visibility to maintainer (#782)

This commit is contained in:
Chuck Lantz 2021-03-09 10:34:45 -08:00 коммит произвёл GitHub
Родитель 403227bab7
Коммит 50d0a73d1b
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
48 изменённых файлов: 107 добавлений и 32 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

48
script-library/README.md
Просмотреть файл

@ -12,30 +12,30 @@ Script names end in the Linux distribution "tree" they support. The majority are
Some scripts have special installation instructions (like `desktop-lite-debian.sh`). Consult the following documents for more information (in order of the script name):
| Document | Script |
|----------|--------|
| [Azure CLI Install Script](docs/azcli.md) | `azcli-debian.sh` |
| [Common Script](docs/common.md) | `common-debian.sh`<br />`common-alpine.sh`<br />`common-redhat.sh` (Community) |
| [Desktop (Lightweight) Install Script](docs/desktop-lite.md) | `desktop-lite-debian.sh` |
| [Docker-from-Docker Install Script](docs/docker.md) | `docker-debian.sh`<br />`docker-redhat.sh` (Community) |
| [Docker-in-Docker Install Script](docs/docker-in-docker.md) | `docker-in-docker-debian.sh` |
| [fish Install Script](docs/fish.md) | `fish-debian.sh` |
| [Git Build/Install from Source Script](docs/git-from-src.md) | `git-from-src-debian.sh` |
| [Git LFS Install Script](docs/git-lfs.md) | `git-lfs-debian.sh` |
| [GitHub CLI Install Script](docs/github.md) | `github-debian.sh` |
| [Go (golang) Install Script](docs/go.md) | `go-debian.sh` |
| [Gradle Install Script](docs/gradle.md) | `gradle-debian.sh` |
| [Homebrew Install Script](docs/homebrew.md) | `homebrew-debian.sh` |
| [Java Install Script](docs/java.md) | `java-debian.sh` |
| [Kubectl and Helm Install Script](docs/kubectl-helm.md) | `kubectl-helm-debian.sh` |
| [Maven Install Script](docs/maven.md) | `maven-debian.sh` |
| [Node.js Install Script](docs/node.md) | `node-debian.sh` |
| [PowerShell Install Script](docs/powershell.md) | `powershell-debian.sh` |
| [Python Install Script](docs/python.md) | `python-debian.sh` |
| [Ruby Install Script](docs/ruby.md) | `ruby-debian.sh` |
| [Rust (rustlang) Install Script](docs/rust.md) | `rust-debian.sh` |
| [SSH Server Install Script](docs/sshd.md) | `sshd-debian.sh` |
| [Terraform CLI Install Script](docs/terraform.md) | `terraform-debian.sh` |
| Document | Script | Maintainers |
|----------|--------|------------|
| [Azure CLI Install Script](docs/azcli.md) | `azcli-debian.sh` | VS Code and GitHub Codespaces teams |
| [Common Script](docs/common.md) | `common-debian.sh`<br />`common-alpine.sh`<br />`common-redhat.sh` (Community) | VS Code and GitHub Codespaces teams |
| [Desktop (Lightweight) Install Script](docs/desktop-lite.md) | `desktop-lite-debian.sh` | VS Code and GitHub Codespaces teams|
| [Docker-in-Docker Install Script](docs/docker-in-docker.md) | `docker-in-docker-debian.sh` | VS Code and GitHub Codespaces teams |
| [Docker-from-Docker Install Script](docs/docker.md) | `docker-debian.sh`<br />`docker-redhat.sh` (Community) | VS Code and GitHub Codespaces teams, [@smankoo](https://github.com/smankoo) (`docker-redhat.sh`) |
| [fish Install Script](docs/fish.md) | `fish-debian.sh` (Community) | [@andreiborisov](https://github.com/andreiborisov) |
| [Git Build/Install from Source Script](docs/git-from-src.md) | `git-from-src-debian.sh` | VS Code and GitHub Codespaces teams|
| [Git LFS Install Script](docs/git-lfs.md) | `git-lfs-debian.sh` | VS Code and GitHub Codespaces teams|
| [GitHub CLI Install Script](docs/github.md) | `github-debian.sh` | VS Code and GitHub Codespaces teams|
| [Go (golang) Install Script](docs/go.md) | `go-debian.sh` | VS Code and GitHub Codespaces teams|
| [Gradle Install Script](docs/gradle.md) | `gradle-debian.sh` | VS Code and GitHub Codespaces teams|
| [Homebrew Install Script](docs/homebrew.md) | `homebrew-debian.sh` (Community) | [@andreiborisov](https://github.com/andreiborisov) |
| [Java Install Script](docs/java.md) | `java-debian.sh` | VS Code and GitHub Codespaces teams|
| [Kubectl and Helm Install Script](docs/kubectl-helm.md) | `kubectl-helm-debian.sh` | VS Code and GitHub Codespaces teams|
| [Maven Install Script](docs/maven.md) | `maven-debian.sh` | VS Code and GitHub Codespaces teams|
| [Node.js Install Script](docs/node.md) | `node-debian.sh` | VS Code and GitHub Codespaces teams|
| [PowerShell Install Script](docs/powershell.md) | `powershell-debian.sh` | VS Code and GitHub Codespaces teams|
| [Python Install Script](docs/python.md) | `python-debian.sh` | VS Code and GitHub Codespaces teams|
| [Ruby Install Script](docs/ruby.md) | `ruby-debian.sh` | VS Code and GitHub Codespaces teams|
| [Rust (rustlang) Install Script](docs/rust.md) | `rust-debian.sh` | VS Code and GitHub Codespaces teams|
| [SSH Server Install Script](docs/sshd.md) | `sshd-debian.sh` | VS Code and GitHub Codespaces teams|
| [Terraform CLI Install Script](docs/terraform.md) | `terraform-debian.sh` | VS Code and GitHub Codespaces teams|
## Using a script

1
script-library/azcli-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/azcli.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./azcli-debian.sh

1
script-library/common-alpine.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/common.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./common-alpine.sh [install zsh flag] [username] [user UID] [user GID] [install Oh My Zsh! flag]

1
script-library/common-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/common.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./common-debian.sh [install zsh flag] [username] [user UID] [user GID] [upgrade packages flag] [install Oh My Zsh! flag]

6
script-library/common-redhat.sh
Просмотреть файл

@ -4,11 +4,11 @@
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
#-------------------------------------------------------------------------------------------------------------
#
# ** This script is community supported **
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/common.md
# Maintainer: The VS Code and Codespaces Teams
#
# Community supported RedHat based version of common-debian.sh
#
# Syntax: ./common-redhat.sh [install zsh flag] [username] [user UID] [user GID] [upgrade packages flag] [install Oh My *! flag]
# Syntax: ./common-redhat.sh [install zsh flag] [username] [user UID] [user GID] [upgrade packages flag] [install Oh My Zsh! flag]
INSTALL_ZSH=${1:-"true"}
USERNAME=${2:-"automatic"}

1
script-library/desktop-lite-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/desktop-lite.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./desktop-lite-debian.sh [non-root user] [vnc password] [install no vnc flag]

1
script-library/docker-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/docker.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./docker-debian.sh [enable non-root docker socket access flag] [source socket] [target socket] [non-root user] [use moby]

1
script-library/docker-in-docker-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/docker-in-docker.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./docker-in-docker-debian.sh [enable non-root docker access flag] [non-root user] [use moby]

4
script-library/docker-redhat.sh
Просмотреть файл

@ -4,9 +4,9 @@
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
#-------------------------------------------------------------------------------------------------------------
#
# ** This script is community supported **
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/docker.md
#
# Community supported RedHat based version of docker-debian.sh
# Maintainer: @smankoo
#
# Syntax: ./docker-redhat.sh [enable non-root docker socket access flag] [source socket] [target socket] [non-root user]

2
script-library/docs/azcli.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/common.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, Alpine 3.9+, CentOS/RHEL 7+ (community supported) and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/desktop-lite.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
> **Note:** When using a VNC Viewer client, you may need to set the quality level to get high color since it can default to "low" with some clients.
## Syntax

4
script-library/docs/docker-in-docker.md
Просмотреть файл

@ -4,8 +4,12 @@
*Create child containers _inside_ a container, independent from the host's docker instance. Installs Docker extension in the container along with needed CLIs.*
**Script status:** Stable
**OS support**: Debian 9+, Ubuntu 20.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

6
script-library/docs/docker.md
Просмотреть файл

@ -6,6 +6,10 @@
**OS support**: Debian 9+, Ubuntu 16.04+, CentOS/RHEL 7+ (community supported) and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams, [@smankoo](https://github.com/smankoo) (`docker-redhat.sh`)
> **Note:** `docker-redhat.sh` is community supported.
## Syntax
```text
@ -13,8 +17,6 @@
./docker-redhat.sh [Non-root access flag] [Source socket] [Target socket] [Non-root user]
```
> **Note:** `docker-redhat.sh` is community supported.
|Argument|Default|Description|
|--------|-------|-----------|
|Non-root access flag|`true`| Flag (`true`/`false`) that specifies whether a non-root user should be granted access to the Docker socket.|

4
script-library/docs/fish.md
Просмотреть файл

@ -1,11 +1,15 @@
# fish Install Script
> **Note:** This is a community contributed and maintained script.
*Adds [fish shell](https://github.com/fish-shell/fish-shell) to a container.*
**Script status**: Stable
**OS support**: Debian 9+, Ubuntu 16.04+.
**Maintainer:** [@andreiborisov](https://github.com/andreiborisov)
## Syntax
```text

2
script-library/docs/git-from-src.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/git-lfs.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/github.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/go.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/gradle.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

4
script-library/docs/homebrew.md
Просмотреть файл

@ -1,11 +1,15 @@
# Homebrew Install Script
> **Note:** This is a community contributed and maintained script.
*Adds Homebrew to a container.*
**Script status**: Stable
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** [@andreiborisov](https://github.com/andreiborisov)
## Syntax
```text

2
script-library/docs/java.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/kubectl-helm.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/maven.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/node.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/powershell.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

4
script-library/docs/python.md
Просмотреть файл

@ -2,10 +2,12 @@
*Installs Python, PIPX, and common Python utilities.*
**Script status**: Draft
**Script status**: Stable
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/ruby.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/rust.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/sshd.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/docs/terraform.md
Просмотреть файл

@ -6,6 +6,8 @@
**OS support**: Debian 9+, Ubuntu 16.04+, and downstream distros.
**Maintainer:** The VS Code and GitHub Codespaces teams
## Syntax
```text

2
script-library/fish-debian.sh
Просмотреть файл

@ -4,7 +4,9 @@
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
#-------------------------------------------------------------------------------------------------------------
#
# ** This script is community supported **
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/homebrew.md
# Maintainer: @andreiborisov
#
# Syntax: ./fish-debian.sh [whether to install Fisher] [non-root user]

1
script-library/git-from-src-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/git-from-src.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./git-from-src-debian.sh [version]

1
script-library/git-lfs-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/git-lfs.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./git-lfs-debian.sh

1
script-library/github-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/github.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./github-debian.sh [version]

1
script-library/go-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/go.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./go-debian.sh [Go version] [GOROOT] [GOPATH] [non-root user] [Add GOPATH, GOROOT to rc files flag] [Install tools flag]

1
script-library/gradle-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/gradle.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./gradle-debian.sh [Gradle version] [SDKMAN_DIR] [non-root user] [Update rc files flag]

2
script-library/homebrew-debian.sh
Просмотреть файл

@ -4,7 +4,9 @@
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
#-------------------------------------------------------------------------------------------------------------
#
# ** This script is community supported **
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/homebrew.md
# Maintainer: @andreiborisov
#
# Syntax: ./homebrew-debian.sh [non-root user] [add Homebrew binaries to PATH] [whether to use shallow clone] [where to install Homebrew]

1
script-library/java-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/java.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./java-debian.sh [JDK version] [SDKMAN_DIR] [non-root user] [Add to rc files flag]

1
script-library/kubectl-helm-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/kubectl-helm.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./kubectl-helm-debian.sh

1
script-library/maven-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/maven.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./maven-debian.sh [maven version] [SDKMAN_DIR] [non-root user] [Update rc files flag]

1
script-library/node-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/node.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./node-debian.sh [directory to install nvm] [node version to install (use "none" to skip)] [non-root user] [Update rc files flag]

1
script-library/powershell-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/powershell.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./powershell-debian.sh

1
script-library/python-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/python.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./python-debian.sh [Python Version] [Python intall path] [PIPX_HOME] [non-root user] [Update rc files flag] [install tools]

1
script-library/ruby-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/ruby.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./ruby-debian.sh [Ruby version] [non-root user] [Add to rc files flag] [Install tools flag]

1
script-library/rust-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/rust.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./rust-debian.sh [CARGO_HOME] [RUSTUP_HOME] [non-root user] [add CARGO/RUSTUP_HOME to rc files flag] [whether to update rust]

1
script-library/sshd-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/sshd.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./sshd-debian.sh [SSH Port (don't use 22)] [non-root user] [start sshd now flag] [new password for user]
#

1
script-library/terraform-debian.sh
Просмотреть файл

@ -5,6 +5,7 @@
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/terraform.md
# Maintainer: The VS Code and Codespaces Teams
#
# Syntax: ./terraform-debian.sh [terraform version] [tflint version]