Mostly changes to the html, moved pages, fixed links.

* Moved the introduction page to the en/latest/index.html home of the documentation and pointed all links there
* Fixed a broken link from+to homepage
* Fixed the javascript of the documentation navigation to allow expand and collapse multiple times.
* Fixed the one typo Andy pointed out
This commit is contained in:
Thatcher Peskens 2013-05-15 20:00:20 -07:00
parent b5c1b17b50
commit 8454a86e97
10 changed files with 219 additions and 77 deletions

View File

@ -9,7 +9,7 @@ Commands
Contents: Contents:
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 1
cli cli
attach <command/attach> attach <command/attach>

View File

@ -12,6 +12,6 @@ Contents:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
introduction ../index
buildingblocks buildingblocks

View File

@ -2,8 +2,6 @@
:description: An introduction to docker and standard containers? :description: An introduction to docker and standard containers?
:keywords: containers, lxc, concepts, explanation :keywords: containers, lxc, concepts, explanation
.. _introduction:
Introduction Introduction
============ ============

View File

@ -41,7 +41,7 @@ html_add_permalinks = None
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'toctree'
# General information about the project. # General information about the project.
project = u'Docker' project = u'Docker'

View File

@ -1,22 +1,127 @@
:title: docker documentation :title: Introduction
:description: docker documentation :description: An introduction to docker and standard containers?
:keywords: :keywords: containers, lxc, concepts, explanation
Documentation .. _introduction:
=============
This documentation has the following resources: Introduction
============
.. toctree:: Docker - The Linux container runtime
:maxdepth: 1 ------------------------------------
concepts/index Docker complements LXC with a high-level API which operates at the process level. It runs unix processes with strong guarantees of isolation and repeatability across servers.
installation/index
use/index 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.
examples/index
commandline/index
contributing/index - **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.
api/index - **Any server** Docker can run on any x64 machine with a modern linux kernel - whether it's a laptop, a bare metal server or a VM. This makes it perfect for multi-cloud deployments.
faq - **Isolation** docker isolates processes from each other and from the underlying host, using lightweight containers.
- **Repeatability** Because containers are isolated in their own filesystem, they behave the same regardless of where, when, and alongside what they run.
.. image:: concepts/images/lego_docker.jpg .. image:: concepts/images/lego_docker.jpg
What is a Standard Container?
-----------------------------
Docker defines a unit of software delivery called a Standard Container. The goal of a Standard Container is to encapsulate a software component and all its dependencies in
a format that is self-describing and portable, so that any compliant runtime can run it without extra dependency, regardless of the underlying machine and the contents of the container.
The spec for Standard Containers is currently work in progress, but it is very straightforward. It mostly defines 1) an image format, 2) a set of standard operations, and 3) an execution environment.
A great analogy for this is the shipping container. Just like Standard Containers are a fundamental unit of software delivery, shipping containers (http://bricks.argz.com/ins/7823-1/12) are a fundamental unit of physical delivery.
Standard operations
~~~~~~~~~~~~~~~~~~~
Just like shipping containers, Standard Containers define a set of STANDARD OPERATIONS. Shipping containers can be lifted, stacked, locked, loaded, unloaded and labelled. Similarly, standard containers can be started, stopped, copied, snapshotted, downloaded, uploaded and tagged.
Content-agnostic
~~~~~~~~~~~~~~~~~~~
Just like shipping containers, Standard Containers are CONTENT-AGNOSTIC: all standard operations have the same effect regardless of the contents. A shipping container will be stacked in exactly the same way whether it contains Vietnamese powder coffee or spare Maserati parts. Similarly, Standard Containers are started or uploaded in the same way whether they contain a postgres database, a php application with its dependencies and application server, or Java build artifacts.
Infrastructure-agnostic
~~~~~~~~~~~~~~~~~~~~~~~~~~
Both types of containers are INFRASTRUCTURE-AGNOSTIC: they can be transported to thousands of facilities around the world, and manipulated by a wide variety of equipment. A shipping container can be packed in a factory in Ukraine, transported by truck to the nearest routing center, stacked onto a train, loaded into a German boat by an Australian-built crane, stored in a warehouse at a US facility, etc. Similarly, a standard container can be bundled on my laptop, uploaded to S3, downloaded, run and snapshotted by a build server at Equinix in Virginia, uploaded to 10 staging servers in a home-made Openstack cluster, then sent to 30 production instances across 3 EC2 regions.
Designed for automation
~~~~~~~~~~~~~~~~~~~~~~~~~~
Because they offer the same standard operations regardless of content and infrastructure, Standard Containers, just like their physical counterpart, are extremely well-suited for automation. In fact, you could say automation is their secret weapon.
Many things that once required time-consuming and error-prone human effort can now be programmed. Before shipping containers, a bag of powder coffee was hauled, dragged, dropped, rolled and stacked by 10 different people in 10 different locations by the time it reached its destination. 1 out of 50 disappeared. 1 out of 20 was damaged. The process was slow, inefficient and cost a fortune - and was entirely different depending on the facility and the type of goods.
Similarly, before Standard Containers, by the time a software component ran in production, it had been individually built, configured, bundled, documented, patched, vendored, templated, tweaked and instrumented by 10 different people on 10 different computers. Builds failed, libraries conflicted, mirrors crashed, post-it notes were lost, logs were misplaced, cluster updates were half-broken. The process was slow, inefficient and cost a fortune - and was entirely different depending on the language and infrastructure provider.
Industrial-grade delivery
~~~~~~~~~~~~~~~~~~~~~~~~~~
There are 17 million shipping containers in existence, packed with every physical good imaginable. Every single one of them can be loaded on the same boats, by the same cranes, in the same facilities, and sent anywhere in the World with incredible efficiency. It is embarrassing to think that a 30 ton shipment of coffee can safely travel half-way across the World in *less time* than it takes a software team to deliver its code from one datacenter to another sitting 10 miles away.
With Standard Containers we can put an end to that embarrassment, by making INDUSTRIAL-GRADE DELIVERY of software a reality.
Standard Container Specification
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
(TODO)
Image format
~~~~~~~~~~~~
Standard operations
~~~~~~~~~~~~~~~~~~~
- Copy
- Run
- Stop
- Wait
- Commit
- Attach standard streams
- List filesystem changes
- ...
Execution environment
~~~~~~~~~~~~~~~~~~~~~
Root filesystem
^^^^^^^^^^^^^^^
Environment variables
^^^^^^^^^^^^^^^^^^^^^
Process arguments
^^^^^^^^^^^^^^^^^
Networking
^^^^^^^^^^
Process namespacing
^^^^^^^^^^^^^^^^^^^
Resource limits
^^^^^^^^^^^^^^^
Process monitoring
^^^^^^^^^^^^^^^^^^
Logging
^^^^^^^
Signals
^^^^^^^
Pseudo-terminal allocation
^^^^^^^^^^^^^^^^^^^^^^^^^^
Security
^^^^^^^^

View File

@ -7,7 +7,7 @@ Binaries
**This instruction set is meant for hackers who want to try out Docker on a variety of environments.** **This instruction set is meant for hackers who want to try out Docker on a variety of environments.**
Right now, the officially supported distribution are: Right now, the officially supported distributions are:
- :ref:`ubuntu_precise` - :ref:`ubuntu_precise`
- :ref:`ubuntu_raring` - :ref:`ubuntu_raring`

22
docs/sources/toctree.rst Normal file
View File

@ -0,0 +1,22 @@
:title: docker documentation
:description: docker documentation
:keywords:
Documentation
=============
This documentation has the following resources:
.. toctree::
:titlesonly:
concepts/index
installation/index
use/index
examples/index
commandline/index
contributing/index
api/index
faq
.. image:: concepts/images/lego_docker.jpg

View File

@ -66,7 +66,7 @@
<ul class="nav"> <ul class="nav">
<li><a href="http://www.docker.io/">Introduction</a></li> <li><a href="http://www.docker.io/">Introduction</a></li>
<li><a href="http://www.docker.io/gettingstarted/">Getting started</a></li> <li><a href="http://www.docker.io/gettingstarted/">Getting started</a></li>
<li class="active"><a href="{{ pathto('concepts/containers/', 1) }}">Documentation</a></li> <li class="active"><a href="http://docs.docker.io/en/latest/">Documentation</a></li>
</ul> </ul>
<div class="social links" style="float: right; margin-top: 14px; margin-left: 12px"> <div class="social links" style="float: right; margin-top: 14px; margin-left: 12px">
<a class="twitter" href="http://twitter.com/getdocker">Twitter</a> <a class="twitter" href="http://twitter.com/getdocker">Twitter</a>
@ -155,70 +155,87 @@
<!-- script which should be loaded after everything else --> <!-- script which should be loaded after everything else -->
<script type="text/javascript"> <script type="text/javascript">
var shiftWindow = function() { var shiftWindow = function() {
scrollBy(0, -70); scrollBy(0, -70);
console.log("window shifted") console.log("window shifted")
}; };
window.addEventListener("hashchange", shiftWindow); window.addEventListener("hashchange", shiftWindow);
function loadShift() { function loadShift() {
if (window.location.hash) { if (window.location.hash) {
console.log("window has hash"); console.log("window has hash");
shiftWindow(); shiftWindow();
} }
} }
$(window).load(function() { $(window).load(function() {
loadShift(); loadShift();
console.log("late loadshift"); console.log("late loadshift");
}); });
$(function(){ $(function(){
// sidebar accordian-ing // sidebar accordian-ing
// don't apply on last object (it should be the FAQ) // don't apply on last object (it should be the FAQ)
var elements = $('.toctree-l2'); // define an array to which all opened items should be added
for (var i = 0; i < elements.length; i += 1) { var current = $(elements[i]); console.log(current); current.children('ul').hide();} var openmenus = [];
var elements = $('.toctree-l2');
for (var i = 0; i < elements.length; i += 1) { var current = $(elements[i]); current.children('ul').hide();}
// set initial collapsed state // set initial collapsed state
var elements = $('.toctree-l1'); var elements = $('.toctree-l1');
for (var i = 0; i < elements.length; i += 1) { for (var i = 0; i < elements.length; i += 1) {
var current = $(elements[i]); var current = $(elements[i]);
if (current.hasClass('current')) { if (current.hasClass('current')) {
// do nothing
} else {
// collapse children
current.children('ul').hide();
}
}
// attached handler on click currentlink = current.children('a')[0].href;
$('.sidebar > ul > li > a').not(':last').click(function(){ openmenus.push(currentlink);
if ($(this).parent().hasClass('current')) {
$(this).parent().children('ul').slideUp(200, function() {
$(this).parent().removeClass('current'); // toggle after effect
});
} else {
//$('.sidebar > ul > li > ul').slideUp(100);
var current = $(this);
setTimeout(function() { // do nothing
$('.sidebar > ul > li').removeClass('current'); } else {
current.parent().addClass('current'); // toggle before effect // collapse children
current.parent().children('ul').hide(); current.children('ul').hide();
current.parent().children('ul').slideDown(200); }
}, 100); }
}
return false;
});
}); // attached handler on click
</script> $('.sidebar > ul > li > a').not(':last').click(function(){
var index = $.inArray(this.href, openmenus)
if (index > -1) {
console.log(index);
openmenus.splice(index, 1);
$(this).parent().children('ul').slideUp(200, function() {
// $(this).parent().removeClass('current'); // toggle after effect
});
}
else {
openmenus.push(this.href);
console.log(this);
var current = $(this);
setTimeout(function() {
$('.sidebar > ul > li').removeClass('current');
current.parent().addClass('current'); // toggle before effect
current.parent().children('ul').hide();
current.parent().children('ul').slideDown(200);
}, 100);
}
return false;
});
});
</script>
<!-- Google analytics --> <!-- Google analytics -->
<script type="text/javascript"> <script type="text/javascript">

View File

@ -36,7 +36,7 @@
<ul class="nav"> <ul class="nav">
<li><a href="../">Introduction</a></li> <li><a href="../">Introduction</a></li>
<li class="active"><a href="">Getting started</a></li> <li class="active"><a href="">Getting started</a></li>
<li class=""><a href="http://docs.docker.io/en/latest/concepts/introduction/">Documentation</a></li> <li class=""><a href="http://docs.docker.io/en/latest/">Documentation</a></li>
</ul> </ul>
<div class="social links" style="float: right; margin-top: 14px; margin-left: 12px"> <div class="social links" style="float: right; margin-top: 14px; margin-left: 12px">

View File

@ -58,9 +58,9 @@
<div class="pull-right" > <div class="pull-right" >
<ul class="nav"> <ul class="nav">
<li class="active"><a href="../sources">Introduction</a></li> <li class="active"><a href="/">Introduction</a></li>
<li ><a href="gettingstarted">Getting started</a></li> <li ><a href="gettingstarted">Getting started</a></li>
<li class=""><a href="http://docs.docker.io/en/latest/concepts/introduction/">Documentation</a></li> <li class=""><a href="http://docs.docker.io/en/latest/">Documentation</a></li>
</ul> </ul>
<div class="social links" style="float: right; margin-top: 14px; margin-left: 12px"> <div class="social links" style="float: right; margin-top: 14px; margin-left: 12px">