From c970ffc7b3c80358d08a5fe581f552a54a7350e6 Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Fri, 16 Oct 2015 12:35:28 -0700 Subject: [PATCH] Updating with Hugo 15 Signed-off-by: Mary Anthony --- docs/Dockerfile | 20 ++++---------------- docs/minecraft-server.md | 16 ++++++++-------- docs/nginx-web-server.md | 16 ++++++++-------- docs/rethinkdb-dev-database.md | 8 ++++---- docs/userguide.md | 14 +++++++------- 5 files changed, 31 insertions(+), 43 deletions(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index 041cd99d5f..72cc010377 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -1,11 +1,6 @@ -FROM docs/base:latest +FROM docs/base:hugo-github-linking MAINTAINER Mary Anthony (@moxiegirl) -# To get the git info for this repo -COPY . /src - -COPY . /docs/content/kitematic/ - RUN svn checkout https://github.com/docker/compose/trunk/docs /docs/content/compose RUN svn checkout https://github.com/docker/docker/trunk/docs /docs/content/docker RUN svn checkout https://github.com/docker/swarm/trunk/docs /docs/content/swarm @@ -14,14 +9,7 @@ RUN svn checkout https://github.com/docker/tutorials/trunk/docs /docs/content RUN svn checkout https://github.com/docker/opensource/trunk/docs /docs/content/opensource RUN svn checkout https://github.com/docker/machine/trunk/docs /docs/content/machine +# To get the git info for this repo +COPY . /src -# Sed to process GitHub Markdown -# 1-2 Remove comment code from metadata block -# 3 Change ](/word to ](/project/ in links -# 4 Change ](word.md) to ](/project/word) -# 5 Remove .md extension from link text -# 6 Change ](../ to ](/project/word) -# 7 Change ](../../ to ](/project/ --> not implemented -# -# -RUN /src/pre-process.sh /docs +COPY . /docs/content/kitematic/ diff --git a/docs/minecraft-server.md b/docs/minecraft-server.md index 25872ce196..4456e0993f 100755 --- a/docs/minecraft-server.md +++ b/docs/minecraft-server.md @@ -22,7 +22,7 @@ Kitematic](/). Once installed and running, the app should look like this: Create a container from the recommended Minecraft image by clicking the "Create" button. -![create Minecraft container](../images/minecraft-create.png) +![create Minecraft container](images/minecraft-create.png) After the image finishes downloading, you'll see the home screen for the Minecraft container. Your Minecraft server is now up and running inside a Docker @@ -30,24 +30,24 @@ container. Note that we've marked the IP and port you can use to connect to your Minecraft server in red (your IP and port may be different from what's shown). -![Minecraft server port and IP info](../images/minecraft-port.png) +![Minecraft server port and IP info](images/minecraft-port.png) ### Connect to Minecraft server Open your Minecraft client, log in with your Minecraft account and click on the "Multiplayer" button. -![Minecraft login screen](../images/minecraft-login.png) +![Minecraft login screen](images/minecraft-login.png) Click the "Add Server" button to add the Minecraft server you want to connect to. -![Add server](../images/minecraft-login.png) +![Add server](images/minecraft-login.png) Fill in the "Server Address" text box with the marked IP and port from Kitematic you saw earlier. -![Minecraft server address](../images/minecraft-server-address.png) +![Minecraft server address](images/minecraft-server-address.png) Click on the play button to connect to your Minecraft server and enjoy! @@ -58,16 +58,16 @@ Open the "data" folder from Kitematic (You'll need to "Enable all volumes to edi files via Finder"). We use Docker Volume to map the folder from the Minecraft Docker container onto your computer. -![Minecraft data volume](../images/minecraft-data-volume.png) +![Minecraft data volume](images/minecraft-data-volume.png) The Finder will open, allowing you to replace your current map with the new one you desire. -![Minecraft maps](../images/minecraft-map.png) +![Minecraft maps](images/minecraft-map.png) Restart your container by clicking the "Restart" button. -![Restart Minecraft container](../images/minecraft-restart.png) +![Restart Minecraft container](images/minecraft-restart.png) Go back to your Minecraft client and join your server. The new map should load. diff --git a/docs/nginx-web-server.md b/docs/nginx-web-server.md index 923c4886d2..dd9e6599a9 100755 --- a/docs/nginx-web-server.md +++ b/docs/nginx-web-server.md @@ -20,26 +20,26 @@ In this tutorial, you will: In this example website we'll be serving the popular 2048 game, as shown below. Let's get to it! -![2048 game](../images/nginx-2048.png) +![2048 game](images/nginx-2048.png) #### Running the Nginx Web Server Container First, if you haven't yet done so, [download and start Kitematic](/). Once installed and running, the app should look like this: -![Nginx create](../images/nginx-create.png) +![Nginx create](images/nginx-create.png) Click on the _Create_ button of the `hello-world-nginx` listing as shown above. Kitematic will download (also known as pull the image) and then run a tiny Nginx web server in a Docker container, allowing it to serve website data to your Mac. -![download Nginx hello world](../images/nginx-hello-world.png) +![download Nginx hello world](images/nginx-hello-world.png) Once it's done downloading you should see a quick preview of the example website that comes with the container, as shown below. Click on the preview to see the result in your own browser. -![Nginx preview](../images/nginx-preview.png) +![Nginx preview](images/nginx-preview.png) **What just happened?** Kitematic downloaded the `kitematic/hello-world-nginx` image from the Docker Hub and then created and ran a Docker Nginx container from @@ -54,12 +54,12 @@ but you can change this in the container settings. To access the files via finder, click on the in-app folder icon for a container and "Enable all volumes to edit via Finder": -![Nginx data volume](../images/nginx-data-volume.png) +![Nginx data volume](images/nginx-data-volume.png) A Finder window of the folder should open containing the index.html file we see being served by the container. -![Nginx data folder](../images/nginx-data-folder.png) +![Nginx data folder](images/nginx-data-folder.png) #### Serving Your Own Website Data @@ -68,12 +68,12 @@ files](https://github.com/gabrielecirulli/2048/archive/master.zip) for 2048, a popular (and addictive) web-based tile game. Extract this zip file into the folder you just opened: -![Website files for 2048](../images/nginx-2048-files.png) +![Website files for 2048](images/nginx-2048-files.png) Switch back to Kitematic and restart the container by clicking the "Restart" button as shown below. Your Nginx container should now be serving 2048. -![Nginx running 2048](../images/nginx-serving-2048.png) +![Nginx running 2048](images/nginx-serving-2048.png) **What just happened?** diff --git a/docs/rethinkdb-dev-database.md b/docs/rethinkdb-dev-database.md index 817ba2d7c0..c5546274cb 100755 --- a/docs/rethinkdb-dev-database.md +++ b/docs/rethinkdb-dev-database.md @@ -22,19 +22,19 @@ First, if you haven't yet done so, [download and start Kitematic](/). Once open, the app should look like this: -![Rethink create button](../images/rethink-create.png) +![Rethink create button](images/rethink-create.png) Click on the _Create_ button of the `rethinkdb` image listing in the recommended list as shown above. This will download & run a RethinkDB container within a few minutes. Once it's done, you'll have a local RethinkDB database up and running. -![Rethink container](../images/rethink-container.png) +![Rethink container](images/rethink-container.png) Let's start using it to develop a node.js app. For now, let's figure out which IP address and port RethinkDB is listening on. To find out, click the `Settings` tab and then the `Ports` section: -![Rethink create button](../images/rethink-ports.png) +![Rethink create button](images/rethink-ports.png) You can see there that for RethinkDB port `28015`, the container is listening on host `192.168.99.100` and port `49154` (in this example - ports may be different @@ -65,5 +65,5 @@ 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) diff --git a/docs/userguide.md b/docs/userguide.md index 6589d5c1a6..698b9f8bf3 100755 --- a/docs/userguide.md +++ b/docs/userguide.md @@ -50,7 +50,7 @@ The "New Container" page lets you search for and select from images on the Docke When you've found the image you want to run, you can click "Create" to pull, create, and run the container. -![Nginx create](../images/browse-images.png) +![Nginx create](images/browse-images.png) ## Working with a container @@ -64,7 +64,7 @@ for your container - either a preview of the HTML output for a container that ha server, the main container process' logs, and any container volumes that have been configured. -![Redis container in Kitematic](../images/cli-redis-container.png) +![Redis container in Kitematic](images/cli-redis-container.png) The summary page will show different things depending on the image metadata. If a known "web" port (see below) is `EXPOSED`, then Kitematic assumes its a web page, @@ -103,7 +103,7 @@ This allows you to manage files in volumes via the Finder. Kitematic exposes a container's volume data under `~/Documents/Kitematic//`. Quick access to this folder (or directory) is available via the app: -![Accessing the volumes directory](../images/volumes-dir.png) +![Accessing the volumes directory](images/volumes-dir.png) > **Note**: When you "Enable all volumes to edit files in Finder", the Docker > container will be stopped, removed and re-created with the new `volumes` @@ -120,7 +120,7 @@ already have the HTML, Javascript, and CSS for your website under Navigate to the "Settings" tab of the container, and go to the "Volumes". This screen allows you to set the mappings individually. -![screen shot 2015-02-28 at 2 48 01 pm](../images/change-folder.png) +![screen shot 2015-02-28 at 2 48 01 pm](images/change-folder.png) > **Note**: When you "Change Folders", the Docker > container will be stopped, removed and re-created with the new `volumes` @@ -175,7 +175,7 @@ directly reflected in Kitematic. To open a terminal via Kitematic, just press the whale button at the bottom left, as shown below: -![CLI access button](../images/cli-access-button.png) +![CLI access button](images/cli-access-button.png) ### Example: Creating a new Redis container @@ -183,7 +183,7 @@ Start by opening a Docker-CLI ready terminal by clicking the whale button as described above. Once the terminal opens, enter `docker run -d -P redis`. This will pull and run a new Redis container via the Docker CLI. -![Docker CLI terminal window](../images/cli-terminal.png) +![Docker CLI terminal window](images/cli-terminal.png) > **Note**: If you're creating containers from the command line, use `docker run -d` > so that Kitematic can re-create the container when settings are changed via the @@ -191,7 +191,7 @@ will pull and run a new Redis container via the Docker CLI. Now, go back to Kitematic. The Redis container should now be visible. -![Redis container in Kitematic](../images/cli-redis-container.png) +![Redis container in Kitematic](images/cli-redis-container.png) ## Next Steps