1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00

Major rearrange of the documentation.

This commit is contained in:
Thatcher Peskens 2013-05-09 17:05:20 -07:00
parent 17c1704f4a
commit 7557af19d8
18 changed files with 167 additions and 111 deletions

View file

@ -44,7 +44,7 @@ clean:
-rm -rf $(BUILDDIR)/*
docs:
-rm -rf $(BUILDDIR)/*
#-rm -rf $(BUILDDIR)/*
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The documentation pages are now in $(BUILDDIR)/html."

View file

@ -0,0 +1,16 @@
:title: docker documentation
:description: docker documentation
:keywords:
API's
=============
This following :
.. toctree::
:maxdepth: 3
registry_api
index_search_api

View file

@ -1,3 +1,8 @@
:title: Docker Index documentation
:description: Documentation for docker Index
:keywords: docker, index, api
=======================
Docker Index Search API
=======================

View file

@ -1,3 +1,8 @@
:title: docker Registry documentation
:description: Documentation for docker Registry and Registry API
:keywords: docker, registry, api, index
===================
Docker Registry API
===================

View file

@ -1,14 +0,0 @@
:title: docker documentation
:description: Documentation for docker builder
:keywords: docker, builder, dockerfile
Builder
=======
Contents:
.. toctree::
:maxdepth: 2
basics

View file

@ -4,7 +4,7 @@
.. _cli:
Command Line Interface
Overview
======================
Docker Usage
@ -24,7 +24,7 @@ Available Commands
~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 1
:maxdepth: 2
command/attach
command/build

View file

@ -11,6 +11,31 @@ Contents:
.. toctree::
:maxdepth: 3
basics
workingwithrepository
cli
command/attach
command/build
command/commit
command/diff
command/export
command/history
command/images
command/import
command/info
command/inspect
command/kill
command/login
command/logs
command/port
command/ps
command/pull
command/push
command/restart
command/rm
command/rmi
command/run
command/search
command/start
command/stop
command/tag
command/version
command/wait

View file

@ -1,42 +0,0 @@
.. _working_with_the_repository:
Working with the repository
============================
Connecting to the repository
----------------------------
You create a user on the central docker repository by running
.. code-block:: bash
docker login
If your username does not exist it will prompt you to also enter a password and your e-mail address. It will then
automatically log you in.
Committing a container to a named image
---------------------------------------
In order to commit to the repository it is required to have committed your container to an image with your namespace.
.. code-block:: bash
# for example docker commit $CONTAINER_ID dhrp/kickassapp
docker commit <container_id> <your username>/<some_name>
Pushing a container to the repository
-----------------------------------------
In order to push an image to the repository you need to have committed your container to a named image (see above)
Now you can commit this image to the repository
.. code-block:: bash
# for example docker push dhrp/kickassapp
docker push <image-name>

View file

Before

Width:  |  Height:  |  Size: 194 KiB

After

Width:  |  Height:  |  Size: 194 KiB

View file

@ -20,7 +20,7 @@ Docker is a great building block for automating distributed systems: large-scale
- **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:: http://www.docker.io/_static/lego_docker.jpg
.. image:: images/lego_docker.jpg
What is a Standard Container?

View file

@ -12,14 +12,11 @@ This documentation has the following resources:
concepts/index
installation/index
use/index
examples/index
contributing/index
commandline/index
registry/index
index/index
builder/index
remote-api/index
contributing/index
api/index
faq
.. image:: http://www.docker.io/_static/lego_docker.jpg
.. image:: concepts/images/lego_docker.jpg

View file

@ -1,15 +0,0 @@
:title: Docker Index documentation
:description: Documentation for docker Index
:keywords: docker, index, api
Index
=====
Contents:
.. toctree::
:maxdepth: 2
search

View file

@ -1,15 +0,0 @@
:title: docker Registry documentation
:description: Documentation for docker Registry and Registry API
:keywords: docker, registry, api, index
Registry
========
Contents:
.. toctree::
:maxdepth: 2
api

View file

@ -76,8 +76,8 @@ Expose a service on a TCP port
echo "Daemon received: $(docker logs $JOB)"
Committing (saving) an image
-----------------------------
Committing (saving) a container state
-------------------------------------
Save your containers state to a container image, so the state can be re-used.

View file

@ -0,0 +1,18 @@
:title: docker documentation
:description: -- todo: change me
:keywords: todo: change me
Use
========
Contents:
.. toctree::
:maxdepth: 1
basics
workingwithrepository
builder

View file

@ -0,0 +1,75 @@
.. _working_with_the_repository:
Working with the repository
============================
Top-level repositories and user repositories
--------------------------------------------
Generally, there are two types of repositories: Top-level repositories which are controlled by the people behind
Docker, and user repositories.
* Top-level repositories can easily be recognized by not having a / (slash) in their name. These repositories can
generally be trusted.
* User repositories always come in the form of <username>/<repo_name>. This is what your published images will look like.
* User images are not checked, it is therefore up to you whether or not you trust the creator of this image.
Find public images available on the index
-----------------------------------------
Seach by name, namespace or description
.. code-block:: bash
docker search <value>
Download them simply by their name
.. code-block:: bash
docker pull <value>
Very similarly you can search for and browse the index online on https://index.docker.io
Connecting to the repository
----------------------------
You can create a user on the central docker repository online, or by running
.. code-block:: bash
docker login
If your username does not exist it will prompt you to also enter a password and your e-mail address. It will then
automatically log you in.
Committing a container to a named image
---------------------------------------
In order to commit to the repository it is required to have committed your container to an image with your namespace.
.. code-block:: bash
# for example docker commit $CONTAINER_ID dhrp/kickassapp
docker commit <container_id> <your username>/<some_name>
Pushing a container to the repository
-----------------------------------------
In order to push an image to the repository you need to have committed your container to a named image (see above)
Now you can commit this image to the repository
.. code-block:: bash
# for example docker push dhrp/kickassapp
docker push <image-name>

View file

@ -206,6 +206,7 @@
} else {
//$('.sidebar > ul > li > ul').slideUp(100);
var current = $(this);
setTimeout(function() {
$('.sidebar > ul > li').removeClass('current');
current.parent().addClass('current'); // toggle before effect