docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

re-formatted advisory blockquote, and added advisories to Toolbox docs 

added kitematic advisories, and updated getting started instructions

incorporated Laura's comments apps --> applications

removed gradient on advisory blockquote because Netlify doesn't like it :-(

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
This commit is contained in:
Victoria Bialas 2016-12-08 15:10:44 -08:00
parent f4008148de
commit f788509332
15 changed files with 34 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_data/advisories.yaml
View File

@ -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 &#8212; 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."

2
_layouts/docs.html
View File

@ -205,7 +205,7 @@ ng\:form {
<div {% if page.notoc %} class="col-xs-12 col-sm-9 col-md-10" {% else %} class="col-xs-12 col-sm-9 col-md-8 col-xl-9" {% endif %} >
<section class="section" id="DocumentationText">
{% if page.title %}<h1>{{ page.title }}</h1>{% endif %}
{% if page.advisory %}<blockquote>{{ site.data.advisories.texts[page.advisory] | markdownify }}</blockquote>{% endif %}
{% if page.advisory %}<blockquote style="border-left: 6px solid #FFD601;">{{ site.data.advisories.texts[page.advisory] | markdownify }}</blockquote>{% endif %}
{% include read_time.html %}
{{ content }}
{% if page.noratings != true %}

3
kitematic/faq.md
View File

@ -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).
look at the [Known issues](./known-issues.md).

5
kitematic/index.md
View File

@ -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).
For information about using Kitematic, take a look at the [User Guide](userguide.md).

11
kitematic/known-issues.md
View File

@ -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 <a href="https://github.com/kitematic/kitematic/issues?q=is%3Aopen+is%3Aissue+label%3Abug">existing GitHub
issues</a> labelled as `bug`.
issues</a> labelled as `bug`.

3
kitematic/minecraft-server.md
View File

@ -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.
server](./nginx-web-server.md) page.

3
kitematic/nginx-web-server.md
View File

@ -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.
the [RethinkDB development Database](./rethinkdb-dev-database.md) example.

3
kitematic/rethinkdb-dev-database.md
View File

@ -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)
![Rethink app preview](images/rethinkdb-preview.png)

6
kitematic/userguide.md
View File

@ -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.
the [Minecraft server](./minecraft-server.md) page.

3
toolbox/faqs/index.md
View File

@ -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).
&nbsp;
&nbsp;

3
toolbox/faqs/troubleshoot.md
View File

@ -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.
&nbsp;
&nbsp;

3
toolbox/index.md
View File

@ -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?** <a href="https://www.docker.com/products/docker-toolbox">Download Docker Toolbox</a> from products.
**Ready to download Toolbox?** <a href="https://www.docker.com/products/docker-toolbox">Download Docker Toolbox</a> from products.

3
toolbox/overview.md
View File

@ -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)
* [Learn about Docker Compose](/compose/overview.md)

3
toolbox/toolbox_install_mac.md
View File

@ -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
```
```

3
toolbox/toolbox_install_windows.md
View File

@ -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.
&nbsp;
&nbsp;