From 89ff488b55c9ebb8d458508df035cac0c55ee01c Mon Sep 17 00:00:00 2001 From: James Turnbull Date: Wed, 15 Jan 2014 19:33:01 -0500 Subject: [PATCH] Added Reference Manual Docker-DCO-1.1-Signed-off-by: James Turnbull (github: jamtur01) --- docs/sources/{ => reference}/api/MAINTAINERS | 0 docs/sources/{ => reference}/api/README.md | 0 .../{ => reference}/api/docker_remote_api.rst | 0 .../api/docker_remote_api_v1.0.rst | 0 .../api/docker_remote_api_v1.1.rst | 0 .../api/docker_remote_api_v1.2.rst | 0 .../api/docker_remote_api_v1.3.rst | 0 .../api/docker_remote_api_v1.4.rst | 0 .../api/docker_remote_api_v1.5.rst | 0 .../api/docker_remote_api_v1.6.rst | 0 .../api/docker_remote_api_v1.7.rst | 0 .../api/docker_remote_api_v1.8.rst | 0 .../api/docker_remote_api_v1.9.rst | 0 docs/sources/{ => reference}/api/index.rst | 0 docs/sources/{ => reference}/api/index_api.rst | 0 .../{ => reference}/api/registry_api.rst | 0 .../api/registry_index_spec.rst | 0 .../api/remote_api_client_libraries.rst | 0 docs/sources/{use => reference}/builder.rst | 0 .../{ => reference}/commandline/cli.rst | 0 .../commandline/docker_images.gif | Bin .../{ => reference}/commandline/index.rst | 0 docs/sources/reference/index.rst | 17 +++++++++++++++++ docs/sources/toctree.rst | 3 +-- docs/sources/use/index.rst | 1 - docs/sources/use/working_with_volumes.rst | 2 +- 26 files changed, 19 insertions(+), 4 deletions(-) rename docs/sources/{ => reference}/api/MAINTAINERS (100%) rename docs/sources/{ => reference}/api/README.md (100%) rename docs/sources/{ => reference}/api/docker_remote_api.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.0.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.1.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.2.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.3.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.4.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.5.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.6.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.7.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.8.rst (100%) rename docs/sources/{ => reference}/api/docker_remote_api_v1.9.rst (100%) rename docs/sources/{ => reference}/api/index.rst (100%) rename docs/sources/{ => reference}/api/index_api.rst (100%) rename docs/sources/{ => reference}/api/registry_api.rst (100%) rename docs/sources/{ => reference}/api/registry_index_spec.rst (100%) rename docs/sources/{ => reference}/api/remote_api_client_libraries.rst (100%) rename docs/sources/{use => reference}/builder.rst (100%) rename docs/sources/{ => reference}/commandline/cli.rst (100%) rename docs/sources/{ => reference}/commandline/docker_images.gif (100%) rename docs/sources/{ => reference}/commandline/index.rst (100%) create mode 100644 docs/sources/reference/index.rst diff --git a/docs/sources/api/MAINTAINERS b/docs/sources/reference/api/MAINTAINERS similarity index 100% rename from docs/sources/api/MAINTAINERS rename to docs/sources/reference/api/MAINTAINERS diff --git a/docs/sources/api/README.md b/docs/sources/reference/api/README.md similarity index 100% rename from docs/sources/api/README.md rename to docs/sources/reference/api/README.md diff --git a/docs/sources/api/docker_remote_api.rst b/docs/sources/reference/api/docker_remote_api.rst similarity index 100% rename from docs/sources/api/docker_remote_api.rst rename to docs/sources/reference/api/docker_remote_api.rst diff --git a/docs/sources/api/docker_remote_api_v1.0.rst b/docs/sources/reference/api/docker_remote_api_v1.0.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.0.rst rename to docs/sources/reference/api/docker_remote_api_v1.0.rst diff --git a/docs/sources/api/docker_remote_api_v1.1.rst b/docs/sources/reference/api/docker_remote_api_v1.1.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.1.rst rename to docs/sources/reference/api/docker_remote_api_v1.1.rst diff --git a/docs/sources/api/docker_remote_api_v1.2.rst b/docs/sources/reference/api/docker_remote_api_v1.2.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.2.rst rename to docs/sources/reference/api/docker_remote_api_v1.2.rst diff --git a/docs/sources/api/docker_remote_api_v1.3.rst b/docs/sources/reference/api/docker_remote_api_v1.3.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.3.rst rename to docs/sources/reference/api/docker_remote_api_v1.3.rst diff --git a/docs/sources/api/docker_remote_api_v1.4.rst b/docs/sources/reference/api/docker_remote_api_v1.4.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.4.rst rename to docs/sources/reference/api/docker_remote_api_v1.4.rst diff --git a/docs/sources/api/docker_remote_api_v1.5.rst b/docs/sources/reference/api/docker_remote_api_v1.5.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.5.rst rename to docs/sources/reference/api/docker_remote_api_v1.5.rst diff --git a/docs/sources/api/docker_remote_api_v1.6.rst b/docs/sources/reference/api/docker_remote_api_v1.6.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.6.rst rename to docs/sources/reference/api/docker_remote_api_v1.6.rst diff --git a/docs/sources/api/docker_remote_api_v1.7.rst b/docs/sources/reference/api/docker_remote_api_v1.7.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.7.rst rename to docs/sources/reference/api/docker_remote_api_v1.7.rst diff --git a/docs/sources/api/docker_remote_api_v1.8.rst b/docs/sources/reference/api/docker_remote_api_v1.8.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.8.rst rename to docs/sources/reference/api/docker_remote_api_v1.8.rst diff --git a/docs/sources/api/docker_remote_api_v1.9.rst b/docs/sources/reference/api/docker_remote_api_v1.9.rst similarity index 100% rename from docs/sources/api/docker_remote_api_v1.9.rst rename to docs/sources/reference/api/docker_remote_api_v1.9.rst diff --git a/docs/sources/api/index.rst b/docs/sources/reference/api/index.rst similarity index 100% rename from docs/sources/api/index.rst rename to docs/sources/reference/api/index.rst diff --git a/docs/sources/api/index_api.rst b/docs/sources/reference/api/index_api.rst similarity index 100% rename from docs/sources/api/index_api.rst rename to docs/sources/reference/api/index_api.rst diff --git a/docs/sources/api/registry_api.rst b/docs/sources/reference/api/registry_api.rst similarity index 100% rename from docs/sources/api/registry_api.rst rename to docs/sources/reference/api/registry_api.rst diff --git a/docs/sources/api/registry_index_spec.rst b/docs/sources/reference/api/registry_index_spec.rst similarity index 100% rename from docs/sources/api/registry_index_spec.rst rename to docs/sources/reference/api/registry_index_spec.rst diff --git a/docs/sources/api/remote_api_client_libraries.rst b/docs/sources/reference/api/remote_api_client_libraries.rst similarity index 100% rename from docs/sources/api/remote_api_client_libraries.rst rename to docs/sources/reference/api/remote_api_client_libraries.rst diff --git a/docs/sources/use/builder.rst b/docs/sources/reference/builder.rst similarity index 100% rename from docs/sources/use/builder.rst rename to docs/sources/reference/builder.rst diff --git a/docs/sources/commandline/cli.rst b/docs/sources/reference/commandline/cli.rst similarity index 100% rename from docs/sources/commandline/cli.rst rename to docs/sources/reference/commandline/cli.rst diff --git a/docs/sources/commandline/docker_images.gif b/docs/sources/reference/commandline/docker_images.gif similarity index 100% rename from docs/sources/commandline/docker_images.gif rename to docs/sources/reference/commandline/docker_images.gif diff --git a/docs/sources/commandline/index.rst b/docs/sources/reference/commandline/index.rst similarity index 100% rename from docs/sources/commandline/index.rst rename to docs/sources/reference/commandline/index.rst diff --git a/docs/sources/reference/index.rst b/docs/sources/reference/index.rst new file mode 100644 index 0000000000..49099d5621 --- /dev/null +++ b/docs/sources/reference/index.rst @@ -0,0 +1,17 @@ +:title: Docker Reference Manual +:description: References +:keywords: docker, references, api, command line, commands + +.. _references: + +Reference Manual +================ + +Contents: + +.. toctree:: + :maxdepth: 1 + + commandline/index + builder + api/index diff --git a/docs/sources/toctree.rst b/docs/sources/toctree.rst index c7c368a3f9..2807ea5932 100644 --- a/docs/sources/toctree.rst +++ b/docs/sources/toctree.rst @@ -14,8 +14,7 @@ This documentation has the following resources: installation/index use/index examples/index - commandline/index + reference/index contributing/index - api/index terms/index faq diff --git a/docs/sources/use/index.rst b/docs/sources/use/index.rst index 7bcd1dd81e..23428226a7 100644 --- a/docs/sources/use/index.rst +++ b/docs/sources/use/index.rst @@ -13,7 +13,6 @@ Contents: :maxdepth: 1 basics - builder workingwithrepository baseimages port_redirection diff --git a/docs/sources/use/working_with_volumes.rst b/docs/sources/use/working_with_volumes.rst index 86576b05e4..d908157473 100644 --- a/docs/sources/use/working_with_volumes.rst +++ b/docs/sources/use/working_with_volumes.rst @@ -9,7 +9,7 @@ Share Directories via Volumes .. versionadded:: v0.3.0 Data volumes have been available since version 1 of the - :doc:`../api/docker_remote_api` + :doc:`../reference/api/docker_remote_api` A *data volume* is a specially-designated directory within one or more containers that bypasses the :ref:`ufs_def` to provide several useful