Merge pull request moby#1698 from metalivedev/1684-Cleanup

Fix moby#1684: Cleanup introduction, working with repos, "use" index.
magnum · Aug 28, 2013 · 1288930 · 1288930
2 parents 4a3b039 + c627ff6
commit 1288930
Show file tree

Hide file tree

Showing 17 changed files with 78 additions and 203 deletions.
diff --git a/docs/sources/commandline/command/cp.rst b/docs/sources/commandline/command/cp.rst
@@ -2,12 +2,13 @@
 :description: Copy files/folders from the containers filesystem to the host path
 :keywords: cp, docker, container, documentation, copy
 
-===========================================================
+============================================================================
 ``cp`` -- Copy files/folders from the containers filesystem to the host path
-===========================================================
+============================================================================
 
 ::
 
     Usage: docker cp CONTAINER:RESOURCE HOSTPATH
 
-    Copy files/folders from the containers filesystem to the host path.  Paths are relative to the root of the filesystem.
+    Copy files/folders from the containers filesystem to the host
+    path.  Paths are relative to the root of the filesystem.
diff --git a/docs/sources/concepts/images/lego_docker.jpg b/docs/sources/concepts/images/lego_docker.jpg
diff --git a/docs/sources/concepts/index.rst b/docs/sources/concepts/index.rst
diff --git a/docs/sources/concepts/manifesto.rst b/docs/sources/concepts/manifesto.rst
diff --git a/docs/sources/examples/mongodb.rst b/docs/sources/examples/mongodb.rst
@@ -25,7 +25,7 @@ Create an empty file called ``Dockerfile``:
 
 Next, define the parent image you want to use to build your own image on top of.
 Here, we’ll use `Ubuntu <https://index.docker.io/_/ubuntu/>`_ (tag: ``latest``)
-available on the `docker index`_:
+available on the `docker index <http://index.docker.io>`_:
 
 .. code-block:: bash
 

diff --git a/docs/sources/index.rst b/docs/sources/index.rst
@@ -1,11 +1,11 @@
-:title: Welcome to the Docker Documentation
+:title: Docker Documentation
 :description: An overview of the Docker Documentation
 :keywords: containers, lxc, concepts, explanation
 
-Welcome
-=======
+.. image:: static_files/dockerlogo-h.png
 
-.. image:: concepts/images/dockerlogo-h.png
+Introduction
+------------
 
 ``docker``, the Linux Container Runtime, runs Unix processes with
 strong guarantees of isolation across servers. Your software runs

diff --git a/docs/sources/installation/ubuntulinux.rst b/docs/sources/installation/ubuntulinux.rst
@@ -2,10 +2,10 @@
 :description: Please note this project is currently under heavy development. It should not be used in production.
 :keywords: Docker, Docker documentation, requirements, virtualbox, vagrant, git, ssh, putty, cygwin, linux
 
-.. _ubuntu_linux:
-
 **These instructions have changed for 0.6. If you are upgrading from an earlier version, you will need to follow them again.**
 
+.. _ubuntu_linux:
+
 Ubuntu Linux
 ============
 

diff --git a/docs/sources/installation/vagrant.rst b/docs/sources/installation/vagrant.rst
@@ -2,10 +2,10 @@
 :description: This guide will setup a new virtualbox virtual machine with docker installed on your computer.
 :keywords: Docker, Docker documentation, virtualbox, vagrant, git, ssh, putty, cygwin
 
-.. _install_using_vagrant:
-
 **Vagrant installation is temporarily out of date, it will be updated for 0.6 soon.**
 
+.. _install_using_vagrant:
+
 Using Vagrant (Mac, Linux)
 ==========================
 

diff --git a/docs/sources/installation/windows.rst b/docs/sources/installation/windows.rst
@@ -2,10 +2,10 @@
 :description: Docker's tutorial to run docker on Windows
 :keywords: Docker, Docker documentation, Windows, requirements, virtualbox, vagrant, git, ssh, putty, cygwin
 
-.. _windows:
-
 **Vagrant installation is temporarily out of date, it will be updated for 0.6 soon.**
 
+.. _windows:
+
 Using Vagrant (Windows)
 =======================
 

diff --git a/.../sources/concepts/images/dockerlogo-h.png → docs/sources/static_files/dockerlogo-h.png b/.../sources/concepts/images/dockerlogo-h.png → docs/sources/static_files/dockerlogo-h.png
diff --git a/.../sources/concepts/images/dockerlogo-v.png → docs/sources/static_files/dockerlogo-v.png b/.../sources/concepts/images/dockerlogo-v.png → docs/sources/static_files/dockerlogo-v.png
diff --git a/docs/sources/toctree.rst b/docs/sources/toctree.rst
@@ -10,7 +10,7 @@ This documentation has the following resources:
 .. toctree::
    :titlesonly:
 
-   concepts/index
+   Introduction <index>
    installation/index
    use/index
    examples/index
@@ -19,6 +19,3 @@ This documentation has the following resources:
    api/index
    terms/index
    faq
-
-
-
diff --git a/docs/sources/use/builder.rst b/docs/sources/use/builder.rst
@@ -4,13 +4,13 @@
 
 .. _dockerbuilder:
 
-==================
-Dockerfile Builder
-==================
+======================
+Dockerfiles for Images
+======================
 
 **Docker can act as a builder** and read instructions from a text
-Dockerfile to automate the steps you would otherwise make manually to
-create an image. Executing ``docker build`` will run your steps and
+``Dockerfile`` to automate the steps you would otherwise take manually
+to create an image. Executing ``docker build`` will run your steps and
 commit them along the way, giving you a final image.
 
 .. contents:: Table of Contents
@@ -35,6 +35,8 @@ build succeeds:
 Docker will run your steps one-by-one, committing the result if necessary,
 before finally outputting the ID of your new image.
 
+When you're done with your build, you're ready to look into :ref:`image_push`.
+
 2. Format
 =========
 
@@ -48,9 +50,9 @@ The Dockerfile format is quite simple:
 The Instruction is not case-sensitive, however convention is for them to be
 UPPERCASE in order to distinguish them from arguments more easily.
 
-Docker evaluates the instructions in a Dockerfile in order. **The first
-instruction must be `FROM`** in order to specify the base image from
-which you are building.
+Docker evaluates the instructions in a Dockerfile in order. **The
+first instruction must be `FROM`** in order to specify the
+:ref:`base_image_def` from which you are building.
 
 Docker will ignore **comment lines** *beginning* with ``#``. A comment
 marker anywhere in the rest of the line will be treated as an argument.
@@ -68,7 +70,9 @@ building images.
 
 The ``FROM`` instruction sets the :ref:`base_image_def` for subsequent
 instructions. As such, a valid Dockerfile must have ``FROM`` as its
-first instruction.
+first instruction. The image can be any valid image -- it is
+especially easy to start with an image from the
+:ref:`using_public_repositories`
 
 ``FROM`` must be the first non-comment instruction in the
 ``Dockerfile``.
@@ -160,7 +164,7 @@ override the default specified in CMD.
 The ``EXPOSE`` instruction sets ports to be publicly exposed when
 running the image. This is functionally equivalent to running ``docker
 commit -run '{"PortSpecs": ["<port>", "<port2>"]}'`` outside the
-builder.
+builder. Take a look at :ref:`port_redirection` for more information.
 
 3.6 ENV
 -------

diff --git a/docs/sources/use/index.rst b/docs/sources/use/index.rst
@@ -13,8 +13,8 @@ Contents:
    :maxdepth: 1
 
    basics
+   builder
    workingwithrepository
    port_redirection
-   builder
    puppet
 
diff --git a/docs/sources/use/port_redirection.rst b/docs/sources/use/port_redirection.rst
@@ -3,6 +3,8 @@
 :keywords: Usage, basic port, docker, documentation, examples
 
 
+.. _port_redirection:
+
 Port redirection
 ================