From 82bd3886d54da4fcbcd29cde957568a75ecd186e Mon Sep 17 00:00:00 2001 From: Sven Dowideit Date: Tue, 19 May 2015 05:10:06 +0000 Subject: [PATCH] Add Kitematic documentation to docs.master.docker.com Signed-off-by: Sven Dowideit --- docs/Dockerfile | 43 ++++++++++++++++++++++++++++++++ docs/mkdocs.yml | 7 ++++++ docs/sources/installation/mac.md | 7 +++--- 3 files changed, 53 insertions(+), 4 deletions(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index 8ece2b09ee..bda3ccd9e9 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -10,6 +10,7 @@ ENV COMPOSE_BRANCH release ENV SWARM_BRANCH v0.2.0 ENV MACHINE_BRANCH docs ENV DISTRIB_BRANCH docs +ENV KITEMATIC_BRANCH master # TODO: need the full repo source to get the git version info @@ -116,5 +117,47 @@ ADD https://raw.githubusercontent.com/docker/compose/${COMPOSE_BRANCH}/docs/inde RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/*.md +####################### +# Kitematic +####################### +ADD https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/faq.md \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/index.md \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/known-issues.md \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/minecraft-server.md \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/nginx-web-server.md \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/rethinkdb-dev-database.md \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/userguide.md \ + /docs/sources/kitematic/ +RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/kitematic/*.md +ADD https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/browse-images.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/change-folder.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/cli-access-button.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/cli-redis-container.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/cli-terminal.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/containers.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/installing.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-add-server.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-create.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-data-volume.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-login.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-map.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-port.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-restart.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-server-address.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-2048-files.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-2048.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-create.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-data-folder.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-data-volume.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-hello-world.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-preview.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-serving-2048.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethink-container.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethink-create.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethink-ports.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethinkdb-preview.png \ + https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/volumes-dir.png \ + /docs/sources/kitematic/assets/ + # Then build everything together, ready for mkdocs RUN /docs/build.sh diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 1c1e2eea8c..b501c9c398 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -33,6 +33,7 @@ pages: - ['installation/index.md', '**HIDDEN**'] - ['installation/ubuntulinux.md', 'Installation', 'Ubuntu'] - ['installation/mac.md', 'Installation', 'Mac OS X'] +- ['kitematic/index.md', 'Installation', 'Kitematic on OS X'] - ['installation/windows.md', 'Installation', 'Microsoft Windows'] - ['installation/testing-windows-docker-client.md', 'Installation', 'Building and testing the Windows Docker client'] - ['installation/amazon.md', 'Installation', 'Amazon EC2'] @@ -71,6 +72,7 @@ pages: - ['compose/extends.md', 'User Guide', '    ▪  Extend Compose services' ] - ['machine/index.md', 'User Guide', 'Docker Machine' ] - ['swarm/index.md', 'User Guide', 'Docker Swarm' ] +- ['kitematic/userguide.md', 'User Guide', 'Kitematic'] # Docker Hub docs: - ['docker-hub/index.md', 'Docker Hub', 'Docker Hub' ] @@ -103,6 +105,9 @@ pages: - ['compose/django.md', 'Examples', 'Getting started with Compose and Django'] - ['compose/rails.md', 'Examples', 'Getting started with Compose and Rails'] - ['compose/wordpress.md', 'Examples', 'Getting started with Compose and Wordpress'] +- ['kitematic/minecraft-server.md', 'Examples', 'Kitematic: Minecraft server'] +- ['kitematic/nginx-web-server.md', 'Examples', 'Kitematic: Ngnix web server'] +- ['kitematic/rethinkdb-dev-database.md', 'Examples', 'Kitematic: RethinkDB development database'] # Articles - ['articles/index.md', '**HIDDEN**'] @@ -180,6 +185,8 @@ pages: - ['reference/api/docker_remote_api_v1.0.md', '**HIDDEN**'] - ['reference/api/remote_api_client_libraries.md', 'Reference', 'Docker Remote API client libraries'] - ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker Hub accounts API'] +- ['kitematic/faq.md', 'Reference', 'Kitematic: FAQ'] +- ['kitematic/known-issues.md', 'Reference', 'Kitematic: Known issues'] # Hidden registry files - ['registry/storage-drivers/azure.md', '**HIDDEN**' ] diff --git a/docs/sources/installation/mac.md b/docs/sources/installation/mac.md index 0b4274c2d3..89f75d2dd5 100644 --- a/docs/sources/installation/mac.md +++ b/docs/sources/installation/mac.md @@ -8,14 +8,13 @@ You can install Docker using Boot2Docker to run `docker` commands at your comman Choose this installation if you are familiar with the command-line or plan to contribute to the Docker project on GitHub. +[Download Kitematic](/kitematic/) + Alternatively, you may want to try Kitematic, an application that lets you set up Docker and run containers using a graphical user interface (GUI). -Download Kitematic - - ## Command-line Docker with Boot2Docker Because the Docker daemon uses Linux-specific kernel features, you can't run