aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgithub-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>2022-08-11 22:20:11 +0300
committerGitHub <noreply@github.com>2022-08-11 22:20:11 +0300
commitf8396a6c3531a3a307f5f9d1d3adf065baa7a5a6 (patch)
tree7944171a5826cb46cbbc4599f4e0c567c16fdefd
parent44694d699fd715edeeb9fcea9271b09c39b5ac35 (diff)
Automated documentation update (#90)
Co-authored-by: github-actions <github-actions@github.com>
-rw-r--r--src/common-utils/README.md12
-rw-r--r--src/desktop-lite/README.md8
-rw-r--r--src/docker-from-docker/README.md2
-rw-r--r--src/docker-in-docker/README.md2
-rw-r--r--src/dotnet/README.md5
-rw-r--r--src/java/README.md4
-rw-r--r--src/node/README.md4
-rw-r--r--src/php/README.md3
-rw-r--r--src/python/README.md7
9 files changed, 22 insertions, 25 deletions
diff --git a/src/common-utils/README.md b/src/common-utils/README.md
index 0d381d3..e6e66f5 100644
--- a/src/common-utils/README.md
+++ b/src/common-utils/README.md
@@ -17,13 +17,13 @@ Installs a set of common command line utilities, Oh My Zsh!, and sets up a non-r
| 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 |
+| installZsh | Install ZSH? | boolean | true |
+| installOhMyZsh | Install Oh My Zsh!? | boolean | true |
+| upgradePackages | 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 | - |
+| uid | Enter uid for non-root user | string | automatic |
+| gid | Enter gid for non-root user | string | automatic |
+| nonFreePackages | Add packages from non-free Debian repository? | boolean | - |
---
diff --git a/src/desktop-lite/README.md b/src/desktop-lite/README.md
index 87d7016..709ba44 100644
--- a/src/desktop-lite/README.md
+++ b/src/desktop-lite/README.md
@@ -18,10 +18,10 @@ Adds a lightweight Fluxbox based desktop to the container that can be accessed u
| 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 |
+| noVncVersion | NoVnc Version | string | 1.2.0 |
+| password | Enter a password for desktop connections | string | vscode |
+| webPort | Enter a port for the VNC web client | string | 6080 |
+| vncPort | Enter a port for the desktop VNC server | string | 5901 |
---
diff --git a/src/docker-from-docker/README.md b/src/docker-from-docker/README.md
index 0c29cc6..c13d3f5 100644
--- a/src/docker-from-docker/README.md
+++ b/src/docker-from-docker/README.md
@@ -19,7 +19,7 @@
|-----|-----|-----|-----|
| 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 |
+| dockerDashComposeVersion | Compose version to use for docker-compose (v1 or v2) | string | v1 |
---
diff --git a/src/docker-in-docker/README.md b/src/docker-in-docker/README.md
index 5160e8e..c2e21e0 100644
--- a/src/docker-in-docker/README.md
+++ b/src/docker-in-docker/README.md
@@ -19,7 +19,7 @@ Create child containers *inside* a container, independent from the host's docker
|-----|-----|-----|-----|
| 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 |
+| dockerDashComposeVersion | Default version of Docker Compose (v1 or v2) | string | v1 |
---
diff --git a/src/dotnet/README.md b/src/dotnet/README.md
index 2a215de..3ca4bbd 100644
--- a/src/dotnet/README.md
+++ b/src/dotnet/README.md
@@ -18,9 +18,8 @@ Installs the .NET CLI. Provides option of installing sdk or runtime, and option
| 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 |
+| runtimeOnly | Install just the dotnet runtime if true, and sdk if false. | boolean | - |
+| installUsingApt | If true, it installs using apt instead of the release URL | boolean | true |
---
diff --git a/src/java/README.md b/src/java/README.md
index e9c5701..fcf2afe 100644
--- a/src/java/README.md
+++ b/src/java/README.md
@@ -18,8 +18,8 @@ Installs Java, SDKMAN! (if not installed), and needed dependencies.
| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| version | Select or enter a Java version to install | string | latest |
-| install_gradle | Install Gradle, a build automation tool for multi-language software development | boolean | - |
-| install_maven | Install Maven, a management tool for Java | boolean | - |
+| installGradle | Install Gradle, a build automation tool for multi-language software development | boolean | - |
+| installMaven | Install Maven, a management tool for Java | boolean | - |
---
diff --git a/src/node/README.md b/src/node/README.md
index 03ed8a2..5deab10 100644
--- a/src/node/README.md
+++ b/src/node/README.md
@@ -18,8 +18,8 @@ Installs Node.js, nvm, yarn, and needed dependencies.
| 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 |
+| nodeGypDependencies | Install dependencies to compile native node modules (node-gyp)? | boolean | true |
+| nvmInstallPath | The path where NVM will be installed. | string | /usr/local/share/nvm |
---
diff --git a/src/php/README.md b/src/php/README.md
index 4da537d..443a826 100644
--- a/src/php/README.md
+++ b/src/php/README.md
@@ -18,8 +18,7 @@
| 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 |
+| installComposer | Install PHP Composer? | boolean | true |
---
diff --git a/src/python/README.md b/src/python/README.md
index 13f0c95..3bcddd3 100644
--- a/src/python/README.md
+++ b/src/python/README.md
@@ -18,12 +18,11 @@ Installs the provided version of Python, as well as PIPX, and other common Pytho
| 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 |
+| installTools | 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 | - |
+| installJupyterlab | Install JupyterLab, a web-based interactive development environment for notebooks | boolean | - |
+| configureJupyterlabAllowOrigin | Configure JupyterLab to accept HTTP requests from the specified origin | string | - |
---