clearlinux/docker
2
0
Fork 0
mirror of https://github.com/clearlinux/docker.git synced 2026-09-06 05:31:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2035 from dhrp/style-revamp

Browse Source 
Changes to a new style for the docs. Includes version switcher.
This commit is contained in:
Thatcher
2013-09-30 15:51:43 -07:00
parent 3e7c50e8a1 e3e041b6bf
commit fa44555fb4
29 changed files with 1663 additions and 5764 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/api/docker_remote_api.rst
-34
View File
@@ -9,7 +9,6 @@
Docker Remote API
=================
.. contents:: Table of Contents
1. Brief introduction
=====================
@@ -197,36 +196,3 @@ Initial version
.. _8d73740: https://github.com/dotcloud/docker/commit/8d73740343778651c09160cde9661f5f387b36f4
.. _2e7649b: https://github.com/dotcloud/docker/commit/2e7649beda7c820793bd46766cbc2cfeace7b168
.. _51f6c4a: https://github.com/dotcloud/docker/commit/51f6c4a7372450d164c61e0054daf0223ddbd909
==================================
Docker Remote API Client Libraries
==================================
These libraries have not been tested by the Docker Maintainers for
compatibility. Please file issues with the library owners. If you
find more library implementations, please list them in Docker doc bugs
and we will add the libraries here.
+----------------------+----------------+--------------------------------------------+
| Language/Framework | Name | Repository |
+======================+================+============================================+
| Python | docker-py | https://github.com/dotcloud/docker-py |
+----------------------+----------------+--------------------------------------------+
| Ruby | docker-client | https://github.com/geku/docker-client |
+----------------------+----------------+--------------------------------------------+
| Ruby | docker-api | https://github.com/swipely/docker-api |
+----------------------+----------------+--------------------------------------------+
| Javascript (NodeJS) | docker.io | https://github.com/appersonlabs/docker.io |
| | | Install via NPM: `npm install docker.io` |
+----------------------+----------------+--------------------------------------------+
| Javascript | docker-js | https://github.com/dgoujard/docker-js |
+----------------------+----------------+--------------------------------------------+
| Javascript (Angular) | dockerui | https://github.com/crosbymichael/dockerui |
| **WebUI** | | |
+----------------------+----------------+--------------------------------------------+
| Java | docker-java | https://github.com/kpelykh/docker-java |
+----------------------+----------------+--------------------------------------------+
| Erlang | erldocker | https://github.com/proger/erldocker |
+----------------------+----------------+--------------------------------------------+
| Go | go-dockerclient| https://github.com/fsouza/go-dockerclient |
+----------------------+----------------+--------------------------------------------+
docs/sources/api/index_api.rst
-2
View File
@@ -6,8 +6,6 @@
Docker Index API
=================
.. contents:: Table of Contents
1. Brief introduction
=====================
docs/sources/api/registry_api.rst
+2 -3
View File
@@ -6,7 +6,6 @@
Docker Registry API
===================
.. contents:: Table of Contents
1. Brief introduction
=====================
@@ -497,8 +496,8 @@ Ancestry
:statuscode 200: OK
3.0 Authorization
=================
3 Authorization
===============
This is where we describe the authorization process, including the tokens and cookies.
TODO: add more info.
docs/sources/api/registry_index_spec.rst
+2 -4
View File
@@ -8,8 +8,6 @@
Registry & Index Spec
=====================
.. contents:: Table of Contents
1. The 3 roles
===============
@@ -564,8 +562,8 @@ Next request::
Cookie: session="wD/J7LqL5ctqw8haL10vgfhrb2Q=?foo=UydiYXInCnAxCi4=&timestamp=RjEzNjYzMTQ5NDcuNDc0NjQzCi4="
7.0 Document Version
---------------------
7 Document Version
====================
- 1.0 : May 6th 2013 : initial release
- 1.1 : June 1st 2013 : Added Delete Repository and way to handle new source namespace.
docs/sources/api/remote_api_client_libraries.rst
+37
View File
@@ -0,0 +1,37 @@
:title: Registry API
:description: Various client libraries available to use with the Docker remote API
:keywords: API, Docker, index, registry, REST, documentation, clients, Python, Ruby, Javascript, Erlang, Go
==================================
Docker Remote API Client Libraries
==================================
These libraries have not been tested by the Docker Maintainers for
compatibility. Please file issues with the library owners. If you
find more library implementations, please list them in Docker doc bugs
and we will add the libraries here.
+----------------------+----------------+--------------------------------------------+
| Language/Framework | Name | Repository |
+======================+================+============================================+
| Python | docker-py | https://github.com/dotcloud/docker-py |
+----------------------+----------------+--------------------------------------------+
| Ruby | docker-client | https://github.com/geku/docker-client |
+----------------------+----------------+--------------------------------------------+
| Ruby | docker-api | https://github.com/swipely/docker-api |
+----------------------+----------------+--------------------------------------------+
| Javascript (NodeJS) | docker.io | https://github.com/appersonlabs/docker.io |
| | | Install via NPM: `npm install docker.io` |
+----------------------+----------------+--------------------------------------------+
| Javascript | docker-js | https://github.com/dgoujard/docker-js |
+----------------------+----------------+--------------------------------------------+
| Javascript (Angular) | dockerui | https://github.com/crosbymichael/dockerui |
| **WebUI** | | |
+----------------------+----------------+--------------------------------------------+
| Java | docker-java | https://github.com/kpelykh/docker-java |
+----------------------+----------------+--------------------------------------------+
| Erlang | erldocker | https://github.com/proger/erldocker |
+----------------------+----------------+--------------------------------------------+
| Go | go-dockerclient| https://github.com/fsouza/go-dockerclient |
+----------------------+----------------+--------------------------------------------+
docs/sources/commandline/cli.rst
+65 -34
View File
@@ -8,7 +8,7 @@ Overview
======================
Docker Usage
~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~
To list available commands, either run ``docker`` with no parameters or execute
``docker help``::
@@ -21,40 +21,71 @@ To list available commands, either run ``docker`` with no parameters or execute
...
Available Commands
~~~~~~~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
.. include:: command/attach.rst
.. include:: command/build.rst
.. include:: command/commit.rst
.. include:: command/cp.rst
.. include:: command/diff.rst
.. include:: command/events.rst
.. include:: command/export.rst
.. include:: command/history.rst
.. include:: command/images.rst
.. include:: command/import.rst
.. include:: command/info.rst
.. include:: command/insert.rst
.. include:: command/inspect.rst
.. include:: command/kill.rst
.. include:: command/login.rst
.. include:: command/logs.rst
.. include:: command/port.rst
.. include:: command/ps.rst
.. include:: command/pull.rst
.. include:: command/push.rst
.. include:: command/restart.rst
.. include:: command/rm.rst
.. include:: command/rmi.rst
.. include:: command/run.rst
.. include:: command/search.rst
.. include:: command/start.rst
.. include:: command/stop.rst
.. include:: command/tag.rst
.. include:: command/top.rst
.. include:: command/version.rst
.. include:: command/wait.rst
command/attach
command/build
command/commit
command/cp
command/diff
command/events
command/export
command/history
command/images
command/import
command/info
command/insert
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/top
command/version
command/wait
docs/sources/commandline/command/images.rst
+1 -1
View File
@@ -23,4 +23,4 @@ Displaying images visually
sudo docker images -viz | dot -Tpng -o docker.png
.. image:: images/docker_images.gif
.. image:: https://docs.docker.io/en/latest/_static/docker_images.gif
docs/sources/examples/hello_world.rst
+12 -9
View File
@@ -2,6 +2,11 @@
:description: A simple hello world example with Docker
:keywords: docker, example, hello world
.. _examples:
Hello World
-----------
.. _running_examples:
Running the Examples
@@ -166,13 +171,11 @@ See the example in action
The next example in the series is a :ref:`python_web_app` example, or
you could skip to any of the other examples:
.. toctree::
:maxdepth: 1
python_web_app
nodejs_web_app
running_redis_service
running_ssh_service
couchdb_data_volumes
postgresql_service
mongodb
* :ref:`python_web_app`
* :ref:`nodejs_web_app`
* :ref:`running_redis_service`
* :ref:`running_ssh_service`
* :ref:`running_couchdb_service`
* :ref:`postgresql_service`
* :ref:`mongodb`
docs/sources/index.rst
+1 -1
View File
@@ -2,7 +2,7 @@
:description: An overview of the Docker Documentation
:keywords: containers, lxc, concepts, explanation
.. image:: static_files/dockerlogo-h.png
.. image:: https://www.docker.io/static/img/linked/dockerlogo-horizontal.png
Introduction
------------
docs/sources/commandline/command/images/docker_images.gif → docs/sources/static_files/docker_images.gif
View File
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 35 KiB

docs/sources/static_files/dockerlogo-h.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 15 KiB

docs/sources/toctree.rst
+1 -1
View File
@@ -8,7 +8,7 @@ Documentation
This documentation has the following resources:
.. toctree::
:titlesonly:
:maxdepth: 1
Introduction <index>
installation/index