Skip to content

Commit 82bd388

Browse files
committed
Add Kitematic documentation to docs.master.docker.com
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
1 parent 472538b commit 82bd388

File tree

3 files changed

+53
-4
lines changed

3 files changed

+53
-4
lines changed

docs/Dockerfile

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ ENV COMPOSE_BRANCH release
1010
ENV SWARM_BRANCH v0.2.0
1111
ENV MACHINE_BRANCH docs
1212
ENV DISTRIB_BRANCH docs
13+
ENV KITEMATIC_BRANCH master
1314

1415

1516
# 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
116117

117118
RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/compose/*.md
118119

120+
#######################
121+
# Kitematic
122+
#######################
123+
ADD https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/faq.md \
124+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/index.md \
125+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/known-issues.md \
126+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/minecraft-server.md \
127+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/nginx-web-server.md \
128+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/rethinkdb-dev-database.md \
129+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/userguide.md \
130+
/docs/sources/kitematic/
131+
RUN sed -i.old '1s;^;no_version_dropdown: true;' /docs/sources/kitematic/*.md
132+
ADD https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/browse-images.png \
133+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/change-folder.png \
134+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/cli-access-button.png \
135+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/cli-redis-container.png \
136+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/cli-terminal.png \
137+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/containers.png \
138+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/installing.png \
139+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-add-server.png \
140+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-create.png \
141+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-data-volume.png \
142+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-login.png \
143+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-map.png \
144+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-port.png \
145+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-restart.png \
146+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/minecraft-server-address.png \
147+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-2048-files.png \
148+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-2048.png \
149+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-create.png \
150+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-data-folder.png \
151+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-data-volume.png \
152+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-hello-world.png \
153+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-preview.png \
154+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/nginx-serving-2048.png \
155+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethink-container.png \
156+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethink-create.png \
157+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethink-ports.png \
158+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/rethinkdb-preview.png \
159+
https://raw.githubusercontent.com/kitematic/kitematic/${KITEMATIC_BRANCH}/docs/assets/volumes-dir.png \
160+
/docs/sources/kitematic/assets/
161+
119162
# Then build everything together, ready for mkdocs
120163
RUN /docs/build.sh

docs/mkdocs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ pages:
3333
- ['installation/index.md', '**HIDDEN**']
3434
- ['installation/ubuntulinux.md', 'Installation', 'Ubuntu']
3535
- ['installation/mac.md', 'Installation', 'Mac OS X']
36+
- ['kitematic/index.md', 'Installation', 'Kitematic on OS X']
3637
- ['installation/windows.md', 'Installation', 'Microsoft Windows']
3738
- ['installation/testing-windows-docker-client.md', 'Installation', 'Building and testing the Windows Docker client']
3839
- ['installation/amazon.md', 'Installation', 'Amazon EC2']
@@ -71,6 +72,7 @@ pages:
7172
- ['compose/extends.md', 'User Guide', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Extend Compose services' ]
7273
- ['machine/index.md', 'User Guide', 'Docker Machine' ]
7374
- ['swarm/index.md', 'User Guide', 'Docker Swarm' ]
75+
- ['kitematic/userguide.md', 'User Guide', 'Kitematic']
7476

7577
# Docker Hub docs:
7678
- ['docker-hub/index.md', 'Docker Hub', 'Docker Hub' ]
@@ -103,6 +105,9 @@ pages:
103105
- ['compose/django.md', 'Examples', 'Getting started with Compose and Django']
104106
- ['compose/rails.md', 'Examples', 'Getting started with Compose and Rails']
105107
- ['compose/wordpress.md', 'Examples', 'Getting started with Compose and Wordpress']
108+
- ['kitematic/minecraft-server.md', 'Examples', 'Kitematic: Minecraft server']
109+
- ['kitematic/nginx-web-server.md', 'Examples', 'Kitematic: Ngnix web server']
110+
- ['kitematic/rethinkdb-dev-database.md', 'Examples', 'Kitematic: RethinkDB development database']
106111

107112
# Articles
108113
- ['articles/index.md', '**HIDDEN**']
@@ -180,6 +185,8 @@ pages:
180185
- ['reference/api/docker_remote_api_v1.0.md', '**HIDDEN**']
181186
- ['reference/api/remote_api_client_libraries.md', 'Reference', 'Docker Remote API client libraries']
182187
- ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker Hub accounts API']
188+
- ['kitematic/faq.md', 'Reference', 'Kitematic: FAQ']
189+
- ['kitematic/known-issues.md', 'Reference', 'Kitematic: Known issues']
183190

184191
# Hidden registry files
185192
- ['registry/storage-drivers/azure.md', '**HIDDEN**' ]

docs/sources/installation/mac.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@ You can install Docker using Boot2Docker to run `docker` commands at your comman
88
Choose this installation if you are familiar with the command-line or plan to
99
contribute to the Docker project on GitHub.
1010

11+
[<img src="/installation/images/kitematic.png" alt="Download Kitematic"
12+
style="float:right;">](/kitematic/)
13+
1114
Alternatively, you may want to try <a id="inlinelink" href="https://kitematic.com/"
1215
target="_blank">Kitematic</a>, an application that lets you set up Docker and
1316
run containers using a graphical user interface (GUI).
1417

15-
<a id="graphic" href="https://kitematic.com/" target="_blank"><img
16-
src="/installation/images/kitematic.png" alt="Download Kitematic"></a>
17-
18-
1918
## Command-line Docker with Boot2Docker
2019

2120
Because the Docker daemon uses Linux-specific kernel features, you can't run

0 commit comments

Comments
 (0)