diff --git a/_data/advisories.yaml b/_data/advisories.yaml index e37ce290196..618cf305791 100644 --- a/_data/advisories.yaml +++ b/_data/advisories.yaml @@ -12,6 +12,8 @@ texts: rc: "The Swarm mode feature included in Docker Engine 1.12 is a release candidate feature and might be subject to non backward-compatible changes. Some functionality may change before the feature becomes generally available." docker4mac-beta: "Docker for Mac is currently in public beta. Some functionality may change before the product becomes generally available." docker4win-beta: "Docker for Windows is currently in public beta. Some functionality may change before the product becomes generally available." + toolbox: "**Legacy desktop solution.** Docker Toolbox is for older Mac and Windows systems that do not meet the requirements of [Docker for Mac](/docker-for-mac/) and [Docker for Windows](/docker-for-windows/). We recommend updating to the newer applications, if possible." + kitematic: "**Legacy desktop solution.** Kitematic is a legacy solution, bundled with [Docker Toolbox](/toolbox/overview/). We recommend updating to [Docker for Mac](/docker-for-mac/) or [Docker for Windows](/docker-for-windows/) if your system meets the requirements for one of those applications." swarm: "See [Swarm mode overview](/engine/swarm/) for the orchestration features introduced in Docker Engine 1.12. Only refer to the Docker Swarm documents below for information on the standalone Swarm product." swarm-standalone: "**You are viewing docs for legacy standalone Swarm.** These topics describe standalone Docker Swarm. If you use Docker 1.12 or higher, [Swarm mode](/engine/swarm/) is integrated with Docker Engine. Most users should use integrated Swarm mode — a good place to start is [Getting started with swarm mode](/engine/swarm/swarm-tutorial/) and [Swarm mode CLI commands](/engine/swarm/index.md#swarm-mode-cli-commands). Standalone Docker Swarm is not integrated into the Docker Engine API and CLI commands." engine: "This site contains documentation for the v1.12 release candidate version of Docker Engine. For the Docker Engine v1.11 docs, see [https://docs.docker.com/v1.11/](https://docs.docker.com/v1.11/). Docker for Mac and Docker for Windows are currently in Beta." diff --git a/_layouts/docs.html b/_layouts/docs.html index 2b7d500370d..2442f0f58db 100644 --- a/_layouts/docs.html +++ b/_layouts/docs.html @@ -205,7 +205,7 @@
{% if page.title %}

{{ page.title }}

{% endif %} - {% if page.advisory %}
{{ site.data.advisories.texts[page.advisory] | markdownify }}
{% endif %} + {% if page.advisory %}
{{ site.data.advisories.texts[page.advisory] | markdownify }}
{% endif %} {% include read_time.html %} {{ content }} {% if page.noratings != true %} diff --git a/kitematic/faq.md b/kitematic/faq.md index 34f45dedfb5..830d926c5b6 100644 --- a/kitematic/faq.md +++ b/kitematic/faq.md @@ -1,4 +1,5 @@ --- +advisory: kitematic description: Documentation covering common questions users have about Kitematic keywords: docker, documentation, about, technology, kitematic, gui title: 'Kitematic: Frequently asked questions (FAQ)' @@ -59,4 +60,4 @@ kitematic@docker.com or to open an issue on GitHub. ## Next Steps For information about known issues in the current release of Kitematic, take a -look at the [Known issues](./known-issues.md). \ No newline at end of file +look at the [Known issues](./known-issues.md). diff --git a/kitematic/index.md b/kitematic/index.md index 9dff82436f4..0f176db3860 100644 --- a/kitematic/index.md +++ b/kitematic/index.md @@ -1,9 +1,10 @@ --- +advisory: kitematic description: Documentation that provides an overview of Kitematic and installation instructions keywords: docker, documentation, about, technology, kitematic, gui title: Kitematic --- -Kitematic, the Docker GUI, runs on macOS and Windows operating systems. Beginning with the 1.8 Docker release, you use the Docker Toolbox to install Kitematic. See the [macOS installation guide](/docker-for-mac/) or the [Windows installation guide](/docker-for-windows/) for details on installing with Docker Toolbox. +Kitematic, the Docker GUI, runs on Mac and Windows operating systems. Beginning with the 1.8 Docker release, you use the [Docker Toolbox](/toolbox/overview/) to install Kitematic. -For information about using Kitematic, take a look at the [User Guide](userguide.md). \ No newline at end of file +For information about using Kitematic, take a look at the [User Guide](userguide.md). diff --git a/kitematic/known-issues.md b/kitematic/known-issues.md index d6a4abae95d..a9f8f226979 100644 --- a/kitematic/known-issues.md +++ b/kitematic/known-issues.md @@ -1,15 +1,14 @@ --- +advisory: kitematic description: Information about known issues in Kitematic keywords: docker, documentation, about, technology, kitematic, gui title: 'Kitematic: Known issues' --- -Kitematic is in beta, so we're still working out the kinks. The most common -errors occur at the setup stage since creating a VM reliably with VirtualBox can -be tricky. We are working on this problem. +The most common errors with Kitematic occur at the setup stage since creating a +VM reliably with VirtualBox can be tricky. We are working on this problem. -In the meantime, below are a list of common errors and solutions that work for -most people. +Below are a list of common errors and solutions that work for most people. ## Setup Error or Hanging at 99% @@ -39,4 +38,4 @@ if you're looking to help fix specific issues around VM provisioning. ## View All Issues For a full list of Kitematic bugs or issues see our existing GitHub -issues labelled as `bug`. \ No newline at end of file +issues labelled as `bug`. diff --git a/kitematic/minecraft-server.md b/kitematic/minecraft-server.md index 2cbe0c5f1b6..40550be26d4 100644 --- a/kitematic/minecraft-server.md +++ b/kitematic/minecraft-server.md @@ -1,4 +1,5 @@ --- +advisory: kitematic description: Tutorial demonstrating the setup of a Minecraft server using Docker and Kitematic keywords: docker, documentation, about, technology, kitematic, gui, minecraft, tutorial title: 'Kitematic tutorial: Set up a Minecraft server' @@ -68,4 +69,4 @@ Go back to your Minecraft client and join your server. The new map should load. ## Next Steps For an example using Kitematic to run Nginx, take a look at the [Nginx web -server](./nginx-web-server.md) page. \ No newline at end of file +server](./nginx-web-server.md) page. diff --git a/kitematic/nginx-web-server.md b/kitematic/nginx-web-server.md index 531f9d84d1d..9e8c6cbaa2e 100644 --- a/kitematic/nginx-web-server.md +++ b/kitematic/nginx-web-server.md @@ -1,4 +1,5 @@ --- +advisory: kitematic description: Tutorial demonstrating the setup of an Nginx web server using Docker and Kitematic keywords: docker, documentation, about, technology, kitematic, gui, nginx, tutorial title: 'Kitematic tutorial: Serve a static website with NGINX' @@ -77,4 +78,4 @@ serve a website we downloaded. ## Next Steps For an example using Kitematic to run a Local RethinkDB database, take a look at -the [RethinkDB development Database](./rethinkdb-dev-database.md) example. \ No newline at end of file +the [RethinkDB development Database](./rethinkdb-dev-database.md) example. diff --git a/kitematic/rethinkdb-dev-database.md b/kitematic/rethinkdb-dev-database.md index d3ae737ec67..9d2fe4d8193 100644 --- a/kitematic/rethinkdb-dev-database.md +++ b/kitematic/rethinkdb-dev-database.md @@ -1,4 +1,5 @@ --- +advisory: kitematic description: Tutorial demonstrating the setup of an RethinkDB database for development keywords: docker, documentation, about, technology, kitematic, gui, rethink, tutorial title: 'Kitematic tutorial: Create a local RethinkDB database for development' @@ -58,4 +59,4 @@ Now, point your browser to `http://localhost:8000`. Congratulations, you've successfully used a RethinkDB container in Kitematic to build a real-time chat app. Happy coding! -![Rethink app preview](images/rethinkdb-preview.png) \ No newline at end of file +![Rethink app preview](images/rethinkdb-preview.png) diff --git a/kitematic/userguide.md b/kitematic/userguide.md index ba3f9a83784..f86702c63dc 100644 --- a/kitematic/userguide.md +++ b/kitematic/userguide.md @@ -1,4 +1,5 @@ --- +advisory: kitematic description: Documentation that provides an overview of Kitematic and installation instructions keywords: docker, documentation, about, technology, kitematic, gui title: Kitematic user guide @@ -23,8 +24,7 @@ and configuring volumes. You can use Kitematic to change environment variables, stream logs, and single click terminal into your Docker container all from the GUI. -First, if you haven't yet done so, [download and start -Kitematic](index.md). +First, if you haven't yet done so, download and start Kitematic by installing [Docker Toolbox](/toolbox/overview.md#ready-to-get-started). ## Container list @@ -188,4 +188,4 @@ Now, go back to Kitematic. The Redis container should now be visible. ## Next Steps For an example using Kitematic to run a Minecraft server, take a look at -the [Minecraft server](./minecraft-server.md) page. \ No newline at end of file +the [Minecraft server](./minecraft-server.md) page. diff --git a/toolbox/faqs/index.md b/toolbox/faqs/index.md index 8fae3c262d4..434ae6bcdb2 100644 --- a/toolbox/faqs/index.md +++ b/toolbox/faqs/index.md @@ -1,4 +1,5 @@ --- +advisory: toolbox description: FAQs, troubleshooting, and tips index for Toolbox installs identifier: toolbox_overview_faqs keywords: docker, documentation, about, technology, kitematic, gui, toolbox @@ -13,4 +14,4 @@ In the process of installing and setting up Docker, you might run into problems * _**Looking for help with error messages?**_ Go to [Troubleshooting](troubleshoot.md). -  \ No newline at end of file +  diff --git a/toolbox/faqs/troubleshoot.md b/toolbox/faqs/troubleshoot.md index ce077a3c506..ab532970127 100644 --- a/toolbox/faqs/troubleshoot.md +++ b/toolbox/faqs/troubleshoot.md @@ -1,4 +1,5 @@ --- +advisory: toolbox description: Troubleshooting connectivity and certificate issues keywords: beginner, getting started, FAQs, troubleshooting, Docker title: Troubleshooting @@ -152,4 +153,4 @@ Here is an example of creating a `default` machine with proxies set to `http://e To learn more about using `docker-machine create`, see the [create](/machine/reference/create/) command in the [Docker Machine](/machine/overview/) reference. -  \ No newline at end of file +  diff --git a/toolbox/index.md b/toolbox/index.md index 3d8d2c18c08..4277936a8e7 100644 --- a/toolbox/index.md +++ b/toolbox/index.md @@ -1,4 +1,5 @@ --- +advisory: toolbox description: Documentation that provides an overview of Docker Toolbox and installation instructions keywords: docker, documentation, about, technology, docker toolbox, gui title: Docker Toolbox @@ -8,4 +9,4 @@ Available for both Windows and Mac, Docker Toolbox installs the Docker Client, M **Learn about Docker Toolbox**. See [Docker Toolbox Overview](overview.md) for a quick tour of how to install Toolbox, and get started with Docker Machine, Kitematic, and Docker Compose. -**Ready to download Toolbox?** Download Docker Toolbox from products. \ No newline at end of file +**Ready to download Toolbox?** Download Docker Toolbox from products. diff --git a/toolbox/overview.md b/toolbox/overview.md index dff761604a5..004a69c0c5d 100644 --- a/toolbox/overview.md +++ b/toolbox/overview.md @@ -1,4 +1,5 @@ --- +advisory: toolbox description: Documentation that provides an overview of Toolbox keywords: docker, documentation, about, technology, kitematic, gui, toolbox title: Docker Toolbox Overview @@ -45,4 +46,4 @@ Choose the install instructions for your platform, and follow the steps: * [Learn about Docker Machine](/machine/overview.md) -* [Learn about Docker Compose](/compose/overview.md) \ No newline at end of file +* [Learn about Docker Compose](/compose/overview.md) diff --git a/toolbox/toolbox_install_mac.md b/toolbox/toolbox_install_mac.md index fdfc159ee75..736e731b1c1 100644 --- a/toolbox/toolbox_install_mac.md +++ b/toolbox/toolbox_install_mac.md @@ -1,4 +1,5 @@ --- +advisory: toolbox description: How to install Toolbox on Mac keywords: docker, documentation, install, toolbox, mac title: Install Docker Toolbox on macOS @@ -201,4 +202,4 @@ To uninstall Toolbox on a Mac, do the following: $ rm /usr/local/bin/docker $ rm /usr/local/bin/docker-compose $ rm /usr/local/bin/docker-machine - ``` \ No newline at end of file + ``` diff --git a/toolbox/toolbox_install_windows.md b/toolbox/toolbox_install_windows.md index f2d07d6d447..30014b364de 100644 --- a/toolbox/toolbox_install_windows.md +++ b/toolbox/toolbox_install_windows.md @@ -1,4 +1,5 @@ --- +advisory: toolbox description: How to install Toolbox on Mac keywords: docker, documentation, install, toolbox, win title: Install Docker Toolbox on Windows @@ -192,4 +193,4 @@ To uninstall Toolbox on Windows, do the following: >**Note:** This process does not remove the `docker-install.exe` file. You must delete that file yourself. -  \ No newline at end of file +