From cf6fc379310dd5a77341c8be2ec78626269d0d7c Mon Sep 17 00:00:00 2001 From: Adrien Duermael Date: Wed, 11 Jan 2017 11:04:11 -0800 Subject: [PATCH] fixed links in /apidocs/docker-cloud/includes urls in html files that are included must be absolute, otherwise it only works when the files are included in some specific location. Signed-off-by: Adrien Duermael --- apidocs/docker-cloud/includes/container.html | 18 +++--- apidocs/docker-cloud/includes/node.html | 4 +- .../docker-cloud/includes/nodecluster.html | 4 +- apidocs/docker-cloud/includes/service.html | 58 +++++++++---------- apidocs/docker-cloud/includes/stack.html | 4 +- apidocs/docker-cloud/includes/tag.html | 2 +- apidocs/docker-cloud/includes/triggers.html | 2 +- 7 files changed, 46 insertions(+), 46 deletions(-) diff --git a/apidocs/docker-cloud/includes/container.html b/apidocs/docker-cloud/includes/container.html index 867a472a58..41b18264d3 100644 --- a/apidocs/docker-cloud/includes/container.html +++ b/apidocs/docker-cloud/includes/container.html @@ -446,7 +446,7 @@ cpu_shares -The relative CPU priority of the container (see Runtime Constraints on CPU and Memory for more information) +The relative CPU priority of the container (see Runtime Constraints on CPU and Memory for more information) cpuset @@ -454,7 +454,7 @@ memory -The memory limit of the container in MB (see Runtime Constraints on CPU and Memory for more information) +The memory limit of the container in MB (see Runtime Constraints on CPU and Memory for more information) memory_swap @@ -462,19 +462,19 @@ autorestart -Whether to restart the container automatically if it stops (see Crash recovery for more information) +Whether to restart the container automatically if it stops (see Crash recovery for more information) autodestroy -Whether to terminate the container automatically if it stops (see Autodestroy for more information) +Whether to terminate the container automatically if it stops (see Autodestroy for more information) roles -List of Docker Cloud roles asigned to this container (see API roles for more information)) +List of Docker Cloud roles asigned to this container (see API roles for more information)) linked_to_container -List of IP addresses of the linked containers (see table Container Link attributes below and Service links for more information) +List of IP addresses of the linked containers (see table Container Link attributes below and Service links for more information) link_variables @@ -482,7 +482,7 @@ privileged -Whether the container has Docker’s privileged flag set or not (see Runtime privilege for more information) +Whether the container has Docker’s privileged flag set or not (see Runtime privilege for more information) read_only @@ -494,11 +494,11 @@ net -Network mode set on the container (see table Network Modes below, more information ../../reference/run/#network-settings) +Network mode set on the container (see table Network Modes below, more information /reference/run/#network-settings) pid -PID (Process) Namespace mode for the container (more information ../../reference/run/#pid-settings-pid) +PID (Process) Namespace mode for the container (more information /reference/run/#pid-settings-pid) diff --git a/apidocs/docker-cloud/includes/node.html b/apidocs/docker-cloud/includes/node.html index 943997c753..6fa50cf135 100644 --- a/apidocs/docker-cloud/includes/node.html +++ b/apidocs/docker-cloud/includes/node.html @@ -164,7 +164,7 @@ tags -List of tags to identify the node when deploying services (see Tags for more information) +List of tags to identify the node when deploying services (see Tags for more information) nickname @@ -418,7 +418,7 @@ docker-cloud tag set -t tag-2 7eaf7fff
docker-cloud node upgrade 7eaf7fff
 
-

Upgrades the docker daemon of the node. This will restart your containers on that node. See Docker upgrade for more information.

+

Upgrades the docker daemon of the node. This will restart your containers on that node. See Docker upgrade for more information.

Endpoint Type

diff --git a/apidocs/docker-cloud/includes/nodecluster.html b/apidocs/docker-cloud/includes/nodecluster.html index e15d8151b4..0be9899695 100644 --- a/apidocs/docker-cloud/includes/nodecluster.html +++ b/apidocs/docker-cloud/includes/nodecluster.html @@ -137,7 +137,7 @@ tags -List of tags to identify the node cluster nodes when deploying services (see Tags for more information) +List of tags to identify the node cluster nodes when deploying services (see Tags for more information) provider_options @@ -346,7 +346,7 @@ tags -(optional) List of tags of the node cluster to be used when deploying services see Tags for more information) (default: []) +(optional) List of tags of the node cluster to be used when deploying services see Tags for more information) (default: []) provider_options diff --git a/apidocs/docker-cloud/includes/service.html b/apidocs/docker-cloud/includes/service.html index 8e0c426919..3cc8f9f48f 100644 --- a/apidocs/docker-cloud/includes/service.html +++ b/apidocs/docker-cloud/includes/service.html @@ -244,11 +244,11 @@ net -Network mode to set on the containers (see table Network Modes below, more information ../../docker-cloud/apps/service-links/) +Network mode to set on the containers (see table Network Modes below, more information /docker-cloud/apps/service-links/) pid -Set the PID (Process) Namespace mode for the containers (more information ../../reference/run/#pid-settings-pid) +Set the PID (Process) Namespace mode for the containers (more information /reference/run/#pid-settings-pid) synchronized @@ -376,11 +376,11 @@ sequential_deployment -Whether the containers for this service should be deployed in sequence, linking each of them to the previous containers (see Service scaling for more information) +Whether the containers for this service should be deployed in sequence, linking each of them to the previous containers (see Service scaling for more information) cpu_shares -The relative CPU priority of the containers of the service (see Runtime Constraints on CPU and Memory for more information) +The relative CPU priority of the containers of the service (see Runtime Constraints on CPU and Memory for more information) cpuset @@ -388,7 +388,7 @@ memory -The memory limit of the containers of the service in MB (see Runtime Constraints on CPU and Memory for more information) +The memory limit of the containers of the service in MB (see Runtime Constraints on CPU and Memory for more information) memory_swap @@ -408,15 +408,15 @@ autorestart -Whether to restart the containers of the service automatically if they stop (see Crash recovery for more information) +Whether to restart the containers of the service automatically if they stop (see Crash recovery for more information) autodestroy -Whether to terminate the containers of the service automatically if they stop (see Autodestroy for more information) +Whether to terminate the containers of the service automatically if they stop (see Autodestroy for more information) roles -List of Docker Cloud roles assigned to this service (see Service links for more information) +List of Docker Cloud roles assigned to this service (see Service links for more information) link_variables @@ -424,7 +424,7 @@ privileged -Whether to start the containers with Docker’s privileged flag set or not, which allows containers to access all devices on the host among other things (see Runtime privilege for more information) +Whether to start the containers with Docker’s privileged flag set or not, which allows containers to access all devices on the host among other things (see Runtime privilege for more information) read_only @@ -432,15 +432,15 @@ deployment_strategy -Container distribution among nodes (see table Deployment strategies below and Deployment strategies for more information) +Container distribution among nodes (see table Deployment strategies below and Deployment strategies for more information) tags -List of tags to be used to deploy the service (see Tags for more information) +List of tags to be used to deploy the service (see Tags for more information) autoredeploy -Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see Docker Cloud’s private registry for more information) +Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see Docker Cloud’s private registry for more information) nickname @@ -780,35 +780,35 @@ autorestart -(optional) Whether the containers for this service should be restarted if they stop, i.e. ALWAYS (default: OFF, possible values: OFF, ON_FAILURE, ALWAYS) (see Crash recovery for more information) +(optional) Whether the containers for this service should be restarted if they stop, i.e. ALWAYS (default: OFF, possible values: OFF, ON_FAILURE, ALWAYS) (see Crash recovery for more information) autodestroy -(optional) Whether the containers should be terminated if they stop, i.e. OFF (default: OFF, possible values: OFF, ON_SUCCESS, ALWAYS) (see Autodestroy for more information) +(optional) Whether the containers should be terminated if they stop, i.e. OFF (default: OFF, possible values: OFF, ON_SUCCESS, ALWAYS) (see Autodestroy for more information) sequential_deployment -(optional) Whether the containers should be launched and scaled in sequence, i.e. true (default: false) (see Service scaling for more information) +(optional) Whether the containers should be launched and scaled in sequence, i.e. true (default: false) (see Service scaling for more information) roles -(optional) A list of Docker Cloud API roles to grant the service, i.e. ["global"] (default: [], possible values: global) (see Service links for more information) +(optional) A list of Docker Cloud API roles to grant the service, i.e. ["global"] (default: [], possible values: global) (see Service links for more information) privileged -(optional) Whether to start the containers with Docker’s privileged flag set or not, i.e. false (default: false) (see Runtime privilege for more information) +(optional) Whether to start the containers with Docker’s privileged flag set or not, i.e. false (default: false) (see Runtime privilege for more information) deployment_strategy -(optional) Container distribution among nodes (default: EMPTIEST_NODE, see table Deployment strategies above and Deployment strategies for more information) +(optional) Container distribution among nodes (default: EMPTIEST_NODE, see table Deployment strategies above and Deployment strategies for more information) tags -(optional) A list of tags to be used to deploy the service (see Tags for more information) (default: []) +(optional) A list of tags to be used to deploy the service (see Tags for more information) (default: []) autoredeploy -(optional) Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (default: false) (see Docker Cloud’s private registry for more information) +(optional) Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (default: false) (see Docker Cloud’s private registry for more information) net @@ -1124,11 +1124,11 @@ docker-cloud tag set -t tag-2 7eaf7fff autorestart -(optional) Whether the containers for this service should be restarted if they stop, i.e. ALWAYS (possible values: OFF, ON_FAILURE, ALWAYS) (see Crash recovery for more information) +(optional) Whether the containers for this service should be restarted if they stop, i.e. ALWAYS (possible values: OFF, ON_FAILURE, ALWAYS) (see Crash recovery for more information) autodestroy -(optional) Whether the containers should be terminated if they stop, i.e. OFF (possible values: OFF, ON_SUCCESS, ALWAYS) (see Autodestroy for more information) +(optional) Whether the containers should be terminated if they stop, i.e. OFF (possible values: OFF, ON_SUCCESS, ALWAYS) (see Autodestroy for more information) container_envvars @@ -1140,7 +1140,7 @@ docker-cloud tag set -t tag-2 7eaf7fff cpu_shares -(optional) The relative CPU priority of the containers the service describes (see Runtime Constraints on CPU and Memory for more information) +(optional) The relative CPU priority of the containers the service describes (see Runtime Constraints on CPU and Memory for more information) entrypoint @@ -1156,15 +1156,15 @@ docker-cloud tag set -t tag-2 7eaf7fff memory -(optional) The memory limit of the containers of the service in MB (see Runtime Constraints on CPU and Memory for more information) +(optional) The memory limit of the containers of the service in MB (see Runtime Constraints on CPU and Memory for more information) privileged -(optional) Whether to start the containers with Docker’s privileged flag set or not, i.e. false (see Runtime privilege for more information) +(optional) Whether to start the containers with Docker’s privileged flag set or not, i.e. false (see Runtime privilege for more information) roles -(optional) A list of Docker Cloud API roles to grant the service, i.e. ["global"] (possible values: global) (see Service links for more information) +(optional) A list of Docker Cloud API roles to grant the service, i.e. ["global"] (possible values: global) (see Service links for more information) run_command @@ -1172,7 +1172,7 @@ docker-cloud tag set -t tag-2 7eaf7fff sequential_deployment -(optional) Whether the containers should be launched and scaled in sequence, i.e. true (see Service scaling for more information) +(optional) Whether the containers should be launched and scaled in sequence, i.e. true (see Service scaling for more information) tags @@ -1184,11 +1184,11 @@ docker-cloud tag set -t tag-2 7eaf7fff deployment_strategy -(optional) Container distribution among nodes. A service cannot be updated to or from a deployment strategy of EVERY_NODE. (See table Deployment strategies above and Deployment strategies for more information) +(optional) Container distribution among nodes. A service cannot be updated to or from a deployment strategy of EVERY_NODE. (See table Deployment strategies above and Deployment strategies for more information) autoredeploy -Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see Docker Cloud’s private registry for more information) +Whether to redeploy the containers of the service when its image is updated in Docker Cloud registry (see Docker Cloud’s private registry for more information) net diff --git a/apidocs/docker-cloud/includes/stack.html b/apidocs/docker-cloud/includes/stack.html index 858d12b24f..a7e4b3b3ac 100644 --- a/apidocs/docker-cloud/includes/stack.html +++ b/apidocs/docker-cloud/includes/stack.html @@ -249,7 +249,7 @@
docker-cloud stack create --name hello-world -f docker-compose.yml
 
-

Creates a new stack without starting it. Note that the JSON syntax is abstracted by both, the Docker Cloud CLI and our UI, in order to use Stack YAML files.

+

Creates a new stack without starting it. Note that the JSON syntax is abstracted by both, the Docker Cloud CLI and our UI, in order to use Stack YAML files.

Endpoint Type

@@ -307,7 +307,7 @@
docker-cloud stack export 46aca402
 
-

Get a JSON representation of the stack following the Stack YAML representation.

+

Get a JSON representation of the stack following the Stack YAML representation.

Endpoint Type

diff --git a/apidocs/docker-cloud/includes/tag.html b/apidocs/docker-cloud/includes/tag.html index cefc4595a0..fd457a5d81 100644 --- a/apidocs/docker-cloud/includes/tag.html +++ b/apidocs/docker-cloud/includes/tag.html @@ -47,7 +47,7 @@ } -

Tags are used to target the deployment of services to a specific set of nodes. Learn more

+

Tags are used to target the deployment of services to a specific set of nodes. Learn more

Attributes

diff --git a/apidocs/docker-cloud/includes/triggers.html b/apidocs/docker-cloud/includes/triggers.html index 4ab8c0d952..1cc7e50086 100644 --- a/apidocs/docker-cloud/includes/triggers.html +++ b/apidocs/docker-cloud/includes/triggers.html @@ -49,7 +49,7 @@ } -

Triggers are URLs that will start a redeploy of the service whenever a POST request is sent to them. They require no authorization headers, so they should be treated as access tokens. Triggers can be revoked if they are leaked or no longer used for security purposes. See Triggers for more information.

+

Triggers are URLs that will start a redeploy of the service whenever a POST request is sent to them. They require no authorization headers, so they should be treated as access tokens. Triggers can be revoked if they are leaked or no longer used for security purposes. See Triggers for more information.

This is a namespaced endpoint.