From 892c21624c78d4cce7c57b7760e800b4e8d3d4ca Mon Sep 17 00:00:00 2001 From: Greg Van Liew Date: Wed, 23 May 2018 09:42:26 -0400 Subject: [PATCH 1/2] Formatting and typos in README and CHANGELOG --- CHANGELOG.md | 30 ++++++++++++++--------- README.md | 69 +++++++++++++++++++++++++++++----------------------- 2 files changed, 56 insertions(+), 43 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3689759880..bb5316d784 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,27 +1,32 @@ ## 0.0.27 - 19 May 2018 + * Fixes indentation problem with Python docker-compose.yml files (thanks @brettcannon) [#242](https://github.com/Microsoft/vscode-docker/pull/242) -* Adds support for showing the Docker explorer in a new viewlet +* Adds support for showing the Docker explorer in a new Activity Bar view * Adopt v0.0.17 of the language server (thanks @rcjsuen!) [#249](https://github.com/Microsoft/vscode-docker/pull/249) ## 0.0.26 - 30 Mar 2018 + * Support generating Java Dockerfiles (thanks @testforstephen) [#235](https://github.com/Microsoft/vscode-docker/pull/235) * Support generating Python Dockerfiles (thanks @brettcannon) [#219](https://github.com/Microsoft/vscode-docker/pull/219) ## 0.0.25 - 27 Feb 2018 + * Fixes [#217](https://github.com/Microsoft/vscode-docker/issues/217) to adopt the usage of ASAR in VS Code * Support for multi-select of `docker-compose` files and then issuing the `compose up` or `compose down` commands. * Changed the default of `promptOnSystemPrune` setting to `true`, meaning you will get a confirmation when running the `System Prune` prune command by default. You can change this by setting `docker.promptOnSystemPrune: false` in your `settings.json`. Thanks to [@driskell](https://github.com/driskell) for [PR #213](https://github.com/Microsoft/vscode-docker/pull/213). -* Right click commands on `dockerfile` and `docker-compose.yml` files are now enabled based on a regular expression over the file name rather than being hard coded. +* Right click commands on `dockerfile` and `docker-compose.yml` files are now enabled based on a regular expression over the file name rather than being hard coded. ## 0.0.24 - 02 Feb 2018 -* Fixes [#189](https://github.com/Microsoft/vscode-docker/issues/189) to provide friendly errors when Docker is not running + +* Fixes [#189](https://github.com/Microsoft/vscode-docker/issues/189) to provide friendly errors when Docker is not running * Fixes [#200](https://github.com/Microsoft/vscode-docker/issues/200) to provide two new options `dockerComposeBuild` and `dockerComposeDetached` control how `docker-compose` is launched * Fixes [#208](https://github.com/Microsoft/vscode-docker/issues/208) where an incorrect repository name was being passed to Azure App Services * Update to `v0.0.13` of the Docker Language Server (thanks @rcjsuen) [#198](https://github.com/Microsoft/vscode-docker/pull/198) -* Activate on `onDebugInitialConfigurations` insted of `onDebug` to delay loading (thanks @gregvanl) +* Activate on `onDebugInitialConfigurations` instead of `onDebug` to delay loading (thanks @gregvanl) * Thank you to @DovydasNavickas for [PR #202](https://github.com/Microsoft/vscode-docker/pull/202) to fix grammatical errors ## 0.0.23 - 05 Jan 2018 + * Do not show dangling images in explorer (thanks @johnpapa) [#175](https://github.com/Microsoft/vscode-docker/pull/175) * Add configuration to prompt on System Prune, fixes [#183](https://github.com/Microsoft/vscode-docker/issues/183) * Upgrade to new language server (thanks @rcjsuen) [#173](https://github.com/Microsoft/vscode-docker/pull/173) @@ -31,7 +36,7 @@ * Browse to the Azure portal context menu, fixes [#151](https://github.com/Microsoft/vscode-docker/issues/151) * Add `docker.truncateLongRegistryPaths` and `docker.truncateMaxLength` configuration options enable truncation of long image and container names in the Explorer, fixes [#180](https://github.com/Microsoft/vscode-docker/issues/180) * Images in the Explorer now show age (e.g. '22 days ago') -* Update `Dockerfile` for `go` workspaces (thanks @vladbarosan) [#194](https://github.com/Microsoft/vscode-docker/pull/194) +* Update `Dockerfile` for `go` workspaces (thanks @vladbarosan) [#194](https://github.com/Microsoft/vscode-docker/pull/194) ## 0.0.22 - 13 Nov 2017 @@ -58,8 +63,8 @@ * Add an automatic refresh option for the explorer (`"docker.explorerRefreshInterval": 1000`) * Add support for Multi-Root Workspaces -* Add support for browsing DockerHub and Azure Container Registries -* Add support for deploying images from DockerHub and Azure Container Registries to Azure App Service +* Add support for browsing Docker Hub and Azure Container Registries +* Add support for deploying images from Docker Hub and Azure Container Registries to Azure App Service * `docker-compose` now runs detached and always invokes a build (e.g. `docker-compose -f docker-compose.yml -d --build`) * `docker system prune` command no longer prompts for confirmation * `docker-compose.debuy.yml` no longer contains a volume mapping @@ -76,7 +81,7 @@ * Gracefully handle when Docker is not running * Add Explorer contribution, letting you view Images and Containers in the Explorer viewlet. * Add `--rm` to `docker build` to remove intermediate images -* Thanks to @rcjsuen, moved to the [Dockerfile Language Server](https://github.com/rcjsuen/dockerfile-language-server-nodejs) +* Thanks to @rcjsuen, moved to the [Dockerfile Language Server](https://github.com/rcjsuen/dockerfile-language-server-nodejs) * Update thirdpartynotices.txt, README.md to reflect changes ## 0.0.16 - 09 June 2017 @@ -92,13 +97,15 @@ * Updated the `Docker: Azure CLI` command to fully support running `az acs` commands ## 0.0.14 - 08 May 2017 + * Support for Docker multi stage build Dockerfiles (syntax, linting) * Support different variations on naming of `dockerfile` such as `dockerfile-development` * Bug fixing ## 0.0.13 - 14 March 2017 -* Support for `.yaml` file extension on `docker-compose` files. -* Updated Azure CLI image name, map .azure folder from host file system, fix block running on Windowns containers, fix Windows path issues (this didn't make it into `0.0.12`) + +* Support for `.yaml` file extension on `docker-compose` files. +* Updated Azure CLI image name, map .azure folder from host file system, fix block running on Windows containers, fix Windows path issues (this didn't make it into `0.0.12`) * Added telemetry to understand which commands developers find useful. This will help us refine which commands we add in the future. We track whether the following commands are executed: * `build image` * `compose up`, `compose down` @@ -115,7 +122,6 @@ > Please note, you can turn off telemetry reporting for VS Code and all extensions through the ["telemetry.enableTelemetry": false setting](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting). - ## 0.0.12 - 11 February 2017 * Removed `MAINTAINER` from templates and linting warnings by upgrading the `dockerfile_lint` module (Docker has deprecated `MAINTAINER` in favor of `LABEL`). @@ -125,7 +131,7 @@ ## 0.0.10 - 12 December 2016 * Added context menu support to run the Docker Build command on Dockerfile files from the editor or from the explorer. -* Docker logs now uses the -f flag ([follow](https://docs.docker.com/engine/reference/commandline/logs/)) to continue streaming the logs to terminal. +* Docker logs now uses the -f flag ([follow](https://docs.docker.com/engine/reference/commandline/logs/)) to continue streaming the logs to terminal. ## 0.0.11 - 4 January 2017 diff --git a/README.md b/README.md index 548d4d9210..65e5309f47 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # Docker Support for Visual Studio Code -The Docker extension makes it easy to build, manage and deploy containerized applications from Visual Studio Code, for exmaple: + +The Docker extension makes it easy to build, manage and deploy containerized applications from Visual Studio Code, for example: * Automatic `Dockerfile`, `docker-compose.yml`, and `.dockerignore` file generation (Press `F1` and search for `Docker: Add Docker files to Workspace`) * Syntax highlighting, hover tips, IntelliSense (completions) for `docker-compose.yml` and `Dockerfile` files * Linting (errors and warnings) for `Dockerfile` files -* Command Palette (`F1`) integration for the most common Docker commands (e.g. `docker build`, `docker push`, etc.) -* Explorer integration for managing Images, running Containers, and DockerHub registries -* Deploy images from DockerHub and Azure Container Registries directly to Azure App Service +* Command Palette (`F1`) integration for the most common Docker commands (for example `docker build`, `docker push`, etc.) +* Explorer integration for managing Images, running Containers, and Docker Hub registries +* Deploy images from Docker Hub and Azure Container Registries directly to Azure App Service ## Generating Docker Files @@ -18,24 +19,23 @@ Press `F1` and search for `Docker: Add Docker files to Workspace` to generate `D Rich IntelliSense (completions) for `Dockerfile` and `docker-compose.yml` files: -![intelliSense for DockerFiles](images/intelliSense.gif) +![IntelliSense for DockerFiles](images/intelliSense.gif) ## Docker commands + Many of the most common Docker and docker compose commands are built right into the Command Palette (`F1`). -![intelliSense](images/commands.gif) +![IntelliSense](images/commands.gif) -## Docker View +## Docker View -The Docker extension contributes a new `Docker` View to VS Code. Within the View, the Explorer lets you view and manage your Images, Containers, and browse your DockerHub registry. If the [Azure Account](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) extension is installed, you can browse your [Azure Container Registries](https://docs.microsoft.com/en-us/azure/container-registry/) as well. +The Docker extension contributes a new `Docker` View to VS Code. Within the View, the Explorer lets you view and manage your Images, Containers, and browse your Docker Hub registry. If the [Azure Account](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) extension is installed, you can browse your [Azure Container Registries](https://docs.microsoft.com/en-us/azure/container-registry/) as well. The right click context menu provides quick access to the same rich set of commands found in the Command Palette (`F1`). - ![explorer integration](images/explorer.png) - -You can move the View up or down by dragging the Docker icon and you can hide the View by right clicking on the icon and choosing `Hide`. To bring it back, right click on the Activity Bar area and check the `Docker` item. +You can move the View up or down by dragging the Docker icon and you can hide the View by right clicking on the icon and choosing `Hide`. To bring it back, right click on the Activity Bar area and check the `Docker` item. ![show and hide the view](images/viewRightClick.png) @@ -45,17 +45,17 @@ The `showExplorer` configuration setting controls the visibility of the Explorer "docker.showExplorer": false ``` -> Note: This setting was introduced prior to the View. Setting it to `false` will hide the Explorer within the Docker View. It does not control whether or not the View itself is visible. Future releases of the extension may be able to support a setting to toggle the visibility of the view [48704](https://github.com/Microsoft/vscode/issues/48704). +> Note: This setting was introduced prior to the View. Setting it to `false` will hide the Explorer within the Docker View. It does not control whether or not the View itself is visible. Future releases of the extension may be able to support a setting to toggle the visibility of the view [48704](https://github.com/Microsoft/vscode/issues/48704). ## Deploying images to Azure App Service -With the Docker Explorer you can deploy images from DockerHub Registries or Azure Container Registries, directly to an Azure App Service instance. This functionality requires installing the [Azure Account](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) extension and an Azure Subscription. If you do not have an Azure subscription, [sign up today](https://azure.microsoft.com/en-us/free/?b=16.48) for a free 30 day account and get $200 in Azure Credits to try out any combination of Azure services. +With the Docker Explorer you can deploy images from Docker Hub Registries or Azure Container Registries, directly to an Azure App Service instance. This functionality requires installing the [Azure Account](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) extension and an Azure Subscription. If you do not have an Azure subscription, [sign up today](https://azure.microsoft.com/en-us/free/?b=16.48) for a free 30 day account and get $200 in Azure Credits to try out any combination of Azure services. -The first time you expand the DockerHub node you'll be prompted to log into your DockerHub account. +The first time you expand the Docker Hub node you'll be prompted to log into your Docker Hub account. -![DockerHub Login](images/dockerHubLogin.gif) +![Docker Hub Login](images/dockerHubLogin.gif) -Your user name and password are stored in your operating system credentials vault (e.g. MacOS keychain, Windows Credential Store) so that you don't need to log in every time. You can log out of DockerHub by right clicking on the DockerHub label and choosing log out. This will delete the credentials from the OS store. +Your user name and password are stored in your operating system credentials vault (for example macOS keychain, Windows Credential Store) so that you don't need to log in every time. You can log out of Docker Hub by right clicking on the Docker Hub label and choosing log out. This will delete the credentials from the OS store. To log into Azure, press `F1` and search for `Azure Sign In`. You will then sign into your account using the Device Login flow. Click on "Copy & Open" to open your default browser. @@ -65,16 +65,17 @@ Paste in the access code and continue the sign in process. ![Azure Login](images/devicelogin2.png) -You can now right click on an image in DockerHub or an Azure Container Registry and choose "Deploy Image to Azure App Service". +You can now right click on an image in Docker Hub or an Azure Container Registry and choose "Deploy Image to Azure App Service". ![Deploy to Azure](images/deploytoazure.png) From here you will be prompted for a Resource Group, location, an App Service Plan, and a globally unique website name. ## Azure CLI -Microsoft ships the latest [Azure CLI](https://github.com/azure/azure-cli) as a [Docker image](https://hub.docker.com/r/azuresdk/azure-cli-python/). You can easily launch a container running the CLI from the Command Palette (press F1 and search for `Docker: Azure CLI`). The extension will then run an interactive terminal attached to the container. -After the container is started, you will be prompted to login to your Azure account. From there, set the subscription you want to work with using `az account set` (you can see all of your subscriptions with `az account list`). You do not need to login in every time you run the container becasue the extension volume mounts the local `$HOME/.azure` folder to the container's `$HOME/.azure` folder. +Microsoft ships the latest [Azure CLI](https://github.com/azure/azure-cli) as a [Docker image](https://hub.docker.com/r/azuresdk/azure-cli-python/). You can easily launch a container running the CLI from the Command Palette (press F1 and search for `Docker: Azure CLI`). The extension will then run an interactive terminal attached to the container. + +After the container is started, you will be prompted to login to your Azure account. From there, set the subscription you want to work with using `az account set` (you can see all of your subscriptions with `az account list`). You do not need to login in every time you run the container because the extension volume mounts the local `$HOME/.azure` folder to the container's `$HOME/.azure` folder. ## Configuration Settings @@ -86,10 +87,10 @@ The Docker extension comes with a number of useful configuration settings allowi | `docker.attachShellCommand.windowsContainer` | Attach command to use for Windows containers | `powershell` | `docker.dockerComposeBuild` | Run docker-compose with the --build argument, defaults to true | `true` | `docker.dockerComposeDetached` | Run docker-compose with the --d (detached) argument, defaults to true | `true` -| `docker.defaultRegistry` | Default registry when tagging an image, empty string will target Dockerhub when pushing. | `""` +| `docker.defaultRegistry` | Default registry when tagging an image, empty string will target Docker Hub when pushing. | `""` | `docker.defaultRegistryPath` | Path within registry to push to. | `""` | `docker.explorerRefreshInterval` | Explorer refresh interval, default is 1000ms. | `1000` -|` docker.imageBuildContextPath` | Build context PATH to pass to Docker build command. | `""` +| `docker.imageBuildContextPath` | Build context PATH to pass to Docker build command. | `""` | `docker.languageserver.diagnostics.deprecatedMaintainer` | Controls the diagnostic severity for the deprecated MAINTAINER instruction. | `warning` | `docker.languageserver.diagnostics.directiveCasing` | Controls the diagnostic severity for parser directives that are not written in lowercase. | `warning` | `docker.languageserver.diagnostics.emptyContinuationLine` | Controls the diagnostic severity for flagging empty continuation lines found in instructions that span multiple lines. | `warning` @@ -103,30 +104,36 @@ The Docker extension comes with a number of useful configuration settings allowi | `docker.truncateLongRegistryPaths` | Truncate long Image and Container registry paths in the Explorer. | `false` | `docker.truncateMaxLength` | Maximum number of characters for long registry paths in the Explorer, including ellipsis. | `10` - ## Installation -In VS Code, open the Extension Viewlet, type in `Docker`, locate the extension and click on `Install`. Once the extension is installed you will be prompted to restart Visual Studio Code which will only take (literally) a couple of seconds. -Of course, you will need to have Docker installed on your computer in order to run commands from the Command Palette (F1, type in `Docker`). +In VS Code, open the Extension Viewlet, type in `Docker`, locate the extension and click on `Install`. Once the extension is installed you will be prompted to restart Visual Studio Code which will only take (literally) a couple of seconds. + +Of course, you will need to have Docker installed on your computer in order to run commands from the Command Palette (F1, type in `Docker`). ## Running commands on Linux + By default, Docker runs as the root user, requiring other users to access it with `sudo`. This extension does not assume root access, so you will need to create a Unix group called docker and add users to it. Instructions can be found here: [Create a Docker group](https://docs.docker.com/engine/installation/linux/linux-postinstall/) ## Connecting to `docker-machine` + The default connection of the extension is to connect to the local docker daemon. You can connect to a docker-machine instance if you launch Visual Studio Code and have the DOCKER_HOST environment variable set to a valid host. ## Contributing -There are a couple of ways you can contribute to this repo: -- Ideas, feature requests and bugs: We are open to all ideas and we want to get rid of bugs! Use the Issues section to either report a new issue, provide your ideas or contribute to existing threads -- Documentation: Found a typo or strangely worded sentences? Submit a PR! -- Code: Contribute bug fixes, features or design changes. +There are a couple of ways you can contribute to this repository: + +* Ideas, feature requests and bugs: We are open to all ideas and we want to get rid of bugs! Use the Issues section to either report a new issue, provide your ideas or contribute to existing threads +* Documentation: Found a typo or strangely worded sentences? Submit a PR! +* Code: Contribute bug fixes, features or design changes. ## Legal -Before we can accept your pull request you will need to sign a **Contribution License Agreement**. All you need to do is to submit a pull request, then the PR will get appropriately labelled (e.g. `cla-required`, `cla-norequired`, `cla-signed`, `cla-already-signed`). If you already signed the agreement we will continue with reviewing the PR, otherwise system will tell you how you can sign the CLA. Once you sign the CLA all future PR's will be labeled as `cla-signed`. + +Before we can accept your pull request you will need to sign a **Contribution License Agreement**. All you need to do is to submit a pull request, then the PR will get appropriately labelled (for example `cla-required`, `cla-norequired`, `cla-signed`, `cla-already-signed`). If you already signed the agreement we will continue with reviewing the PR, otherwise system will tell you how you can sign the CLA. Once you sign the CLA all future PR's will be labeled as `cla-signed`. ## Telemetry + This extension collects telemetry data to help us build a better experience for building micro-service applications with Docker and VS Code. We only collect data on which commands are executed. We do not collect any information about image names, paths, etc. The extension respects the `telemetry.enableTelemetry` setting which you can learn more about in our [FAQ](https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting). - -## License + +## License + [MIT](LICENSE.md) From c161544de6881fedbc2fcfeeea66ba6d8894f049 Mon Sep 17 00:00:00 2001 From: Greg Van Liew Date: Thu, 7 Jun 2018 11:11:33 -0700 Subject: [PATCH 2/2] Update Linux post install link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 95af1d38bc..8bdf631ac5 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ Of course, you will need to have Docker installed on your computer in order to r ## Running commands on Linux -By default, Docker runs as the root user, requiring other users to access it with `sudo`. This extension does not assume root access, so you will need to create a Unix group called docker and add users to it. Instructions can be found here: [Create a Docker group](https://docs.docker.com/engine/installation/linux/linux-postinstall/) +By default, Docker runs as the root user, requiring other users to access it with `sudo`. This extension does not assume root access, so you will need to create a Unix group called docker and add users to it. Instructions can be found here: [Create a Docker group](https://docs.docker.com/install/linux/linux-postinstall/) ## Connecting to `docker-machine`