Ver Fonte

Merging dhrp/docs

Solomon Hykes há 12 anos atrás
pai
commit
48a208baf1

+ 1 - 0
README.md

@@ -6,6 +6,7 @@ Docker complements LXC with a high-level API which operates at the process level
 Docker is a great building block for automating distributed systems: large-scale web deployments, database clusters, continuous deployment systems, private PaaS, service-oriented architectures, etc.
 
 ![Docker L](docs/sources/static_files/lego_docker.jpg "Docker")
+=======
 
 * *Heterogeneous payloads*: any combination of binaries, libraries, configuration files, scripts, virtualenvs, jars, gems, tarballs, you name it. No more juggling between domain-specific tools. Docker can deploy and run them all.
 

+ 3 - 3
docs/sources/examples/hello_world_daemon.rst

@@ -16,7 +16,7 @@ out every second. It will continue to do this until we stop it.
 
 .. code-block:: bash
 
-    $ CONTAINER_ID=$(docker run -d base /bin/sh -c "while true; do echo hello world; sleep 1; done")
+    CONTAINER_ID=$(docker run -d base /bin/sh -c "while true; do echo hello world; sleep 1; done")
 
 We are going to run a simple hello world daemon in a new container made from the busybox daemon.
 
@@ -28,7 +28,7 @@ We are going to run a simple hello world daemon in a new container made from the
 
 .. code-block:: bash
 
-    $ docker logs $CONTAINER_ID
+    docker logs $CONTAINER_ID
 
 Check the logs make sure it is working correctly.
 
@@ -54,7 +54,7 @@ Check the process list to make sure it is running.
 
 .. code-block:: bash
 
-    $ docker stop $CONTAINER_ID
+    docker stop $CONTAINER_ID
 
 Stop the container, since we don't need it anymore.
 

+ 7 - 7
docs/sources/examples/python_web_app.rst

@@ -12,44 +12,44 @@ The goal of this example is to show you how you can author your own docker image
 
 .. code-block:: bash
 
-    $ docker pull shykes/pybuilder
+    docker pull shykes/pybuilder
 
 We are downloading the "shykes/pybuilder" docker image
 
 .. code-block:: bash
 
-    $ URL=http://github.com/shykes/helloflask/archive/master.tar.gz
+    URL=http://github.com/shykes/helloflask/archive/master.tar.gz
 
 We set a URL variable that points to a tarball of a simple helloflask web app
 
 .. code-block:: bash
 
-    $ BUILD_JOB=$(docker run -d -t shykes/pybuilder:latest /usr/local/bin/buildapp $URL)
+    BUILD_JOB=$(docker run -d -t shykes/pybuilder:latest /usr/local/bin/buildapp $URL)
 
 Inside of the "shykes/pybuilder" image there is a command called buildapp, we are running that command and passing the $URL variable from step 2 to it, and running the whole thing inside of a new container. BUILD_JOB will be set with the new container_id.
 
 .. code-block:: bash
 
-    $ docker attach $BUILD_JOB
+    docker attach $BUILD_JOB
     [...]
 
 We attach to the new container to see what is going on. Ctrl-C to disconnect
 
 .. code-block:: bash
 
-    $ BUILD_IMG=$(docker commit $BUILD_JOB _/builds/github.com/hykes/helloflask/master)
+    BUILD_IMG=$(docker commit $BUILD_JOB _/builds/github.com/hykes/helloflask/master)
 
 Save the changed we just made in the container to a new image called "_/builds/github.com/hykes/helloflask/master" and save the image id in the BUILD_IMG variable name.
 
 .. code-block:: bash
 
-    $ WEB_WORKER=$(docker run -d -p 5000 $BUILD_IMG /usr/local/bin/runapp)
+    WEB_WORKER=$(docker run -d -p 5000 $BUILD_IMG /usr/local/bin/runapp)
 
 Use the new image we just created and create a new container with network port 5000, and return the container id and store in the WEB_WORKER variable.
 
 .. code-block:: bash
 
-    $ docker logs $WEB_WORKER
+    docker logs $WEB_WORKER
      * Running on http://0.0.0.0:5000/
 
 view the logs for the new container using the WEB_WORKER variable, and if everything worked as planned you should see the line "Running on http://0.0.0.0:5000/" in the log output.

+ 10 - 10
docs/sources/gettingstarted/index.html

@@ -63,7 +63,7 @@
 
 <div class="container">
     <div class="alert alert-info">
-	    <strong>Docker is still under heavy development.</strong> It should not yet be used in production. Check <a href="http://github.com/dotcloud/docker">the repo</a> for recent progress.
+        <strong>Docker is still under heavy development.</strong> It should not yet be used in production. Check <a href="http://github.com/dotcloud/docker">the repo</a> for recent progress.
     </div>
     <div class="row">
         <div class="span6">
@@ -76,8 +76,8 @@
                         <p>Install dependencies:</p>
 
                         <div class="highlight">
-                        <pre>sudo apt-get install lxc wget bsdtar curl</pre>
-                        <pre>sudo apt-get install linux-image-extra-<span class="sb">`</span>uname -r<span class="sb">`</span></pre></div>
+                            <pre>sudo apt-get install lxc wget bsdtar curl</pre>
+                            <pre>sudo apt-get install linux-image-extra-<span class="sb">`</span>uname -r<span class="sb">`</span></pre></div>
 
                         <p>The <code>linux-image-extra</code> package is needed on standard Ubuntu EC2 AMIs in order to install the aufs kernel module.</p>
                     </li>
@@ -85,28 +85,28 @@
                         <p>Install the latest docker binary:</p>
 
                         <div class="highlight">
-                        <pre>wget http://get.docker.io/builds/<span class="k">$(</span>uname -s<span class="k">)</span>/<span class="k">$(</span>uname -m<span class="k">)</span>/docker-master.tgz</pre>
-                        <pre>tar -xf docker-master.tgz</pre>
+                            <pre>wget http://get.docker.io/builds/<span class="k">$(</span>uname -s<span class="k">)</span>/<span class="k">$(</span>uname -m<span class="k">)</span>/docker-master.tgz</pre>
+                            <pre>tar -xf docker-master.tgz</pre>
                         </div>
                     </li>
                     <li>
                         <p>Run your first container!</p>
 
                         <div class="highlight"><pre><span class="nb">cd </span>docker-master</pre>
-                        <pre>sudo ./docker run -i -t base /bin/bash</pre>
+                            <pre>sudo ./docker run -i -t base /bin/bash</pre>
                         </div>
                         <p>Done!</p>
                         <p>Consider adding docker to your <code>PATH</code> for simplicity.</p>
                     </li>
 
-                    Continue with the <a href="examples/hello_world.html#hello-world">Hello world</a> example.
+                    Continue with the <a href="http://docs.docker.io/en/latest/examples/hello_world/">Hello world</a> example.
                 </ol>
             </section>
 
             <section class="contentblock">
                 <h2>Contributing to Docker</h2>
 
-                <p>Want to hack on Docker? Awesome! We have some <a href="/documentation/contributing/contributing.html">instructions to get you started</a>. They are probably not perfect, please let us know if anything feels wrong or incomplete.</p>
+                <p>Want to hack on Docker? Awesome! We have some <a href="http://docs.docker.io/en/latest/contributing/contributing/">instructions to get you started</a>. They are probably not perfect, please let us know if anything feels wrong or incomplete.</p>
             </section>
 
         </div>
@@ -117,8 +117,8 @@
                     vagrant and an Ubuntu virtual machine.</strong></p>
 
                 <ul>
-                    <li><a href="installation/macos.html">Mac OS X and other linuxes</a></li>
-                    <li><a href="installation/windows.html">Windows</a></li>
+                    <li><a href="http://docs.docker.io/en/latest/installation/macos/">Mac OS X and other linuxes</a></li>
+                    <li><a href="http://docs.docker.io/en/latest/installation/windows/">Windows</a></li>
                 </ul>
 
             </section>

+ 1 - 1
docs/sources/index.html

@@ -87,7 +87,7 @@
 
 
                 <div style="display: block; text-align: center;">
-                    <a class="btn btn-custom btn-large" href="gettingstarted/index.html">Let's get started</a>
+                    <a class="btn btn-custom btn-large" href="gettingstarted/">Let's get started</a>
                 </div>
 
 

+ 4 - 1
docs/sources/index.rst

@@ -15,4 +15,7 @@ This documentation has the following resources:
    examples/index
    contributing/index
    commandline/index
-   faq
+   faq
+
+
+.. image:: http://www.docker.io/_static/lego_docker.jpg