Move DTR reference docs to /reference

This commit is contained in:
Joao Fernandes 2017-12-21 14:55:21 -08:00 committed by Jim Galasyn
parent a1fe083f5c
commit 7857b354ed
21 changed files with 60 additions and 67 deletions

View File

@ -1326,17 +1326,62 @@ reference:
path: /compose/reference/overview/ path: /compose/reference/overview/
nosync: true nosync: true
- sectiontitle: Docker Enterprise Edition references - sectiontitle: Docker Enterprise Edition
section: section:
- title: Trusted Registry API - title: DTR 2.5 API
path: /datacenter/dtr/2.5/reference/api/ path: /reference/dtr/2.5/api/
- sectiontitle: DTR 2.5 CLI
section:
- path: /reference/dtr/2.5/cli/
title: Overview
- path: /reference/dtr/2.5/cli/backup/
title: backup
- path: /reference/dtr/2.5/cli/destroy/
title: destroy
title: images
- path: /reference/dtr/2.5/cli/install/
title: install
- path: /reference/dtr/2.5/cli/join/
title: join
- path: /reference/dtr/2.5/cli/reconfigure/
title: reconfigure
- path: /reference/dtr/2.5/cli/remove/
title: remove
- path: /reference/dtr/2.5/cli/restore/
title: restore
- path: /reference/dtr/2.5/cli/upgrade/
title: upgrade
- title: UCP 3.0 API
path: /datacenter/ucp/3.0/reference/api/
- sectiontitle: UCP 3.0 CLI
section:
- path: /datacenter/ucp/3.0/reference/cli/
title: docker/ucp overview
- path: /datacenter/ucp/3.0/reference/cli/backup/
title: backup
- path: /datacenter/ucp/3.0/reference/cli/dump-certs/
title: dump-certs
- path: /datacenter/ucp/3.0/reference/cli/example-config/
title: example-config
- path: /datacenter/ucp/3.0/reference/cli/id/
title: id
- path: /datacenter/ucp/3.0/reference/cli/images/
title: images
- path: /datacenter/ucp/3.0/reference/cli/install/
title: install
- path: /datacenter/ucp/3.0/reference/cli/restart/
title: restart
- path: /datacenter/ucp/3.0/reference/cli/restore/
title: restore
- path: /datacenter/ucp/3.0/reference/cli/stop/
title: stop
- path: /datacenter/ucp/3.0/reference/cli/support/
title: support
- path: /datacenter/ucp/3.0/reference/cli/uninstall-ucp/
title: uninstall-ucp
- path: /datacenter/ucp/3.0/reference/cli/upgrade/
title: upgrade
- title: Trusted Registry CLI
path: /datacenter/dtr/2.5/reference/cli/
nosync: true
- title: Universal Control Plane CLI
path: /datacenter/ucp/3.0/reference/cli/
nosync: true
- sectiontitle: Application Programming Interfaces (APIs) - sectiontitle: Application Programming Interfaces (APIs)
section: section:
@ -1603,34 +1648,7 @@ manuals:
title: Troubleshoot configurations title: Troubleshoot configurations
- path: /datacenter/ucp/3.0/guides/admin/backups-and-disaster-recovery/ - path: /datacenter/ucp/3.0/guides/admin/backups-and-disaster-recovery/
title: Backups and disaster recovery title: Backups and disaster recovery
- sectiontitle: CLI reference
section:
- path: /datacenter/ucp/3.0/reference/cli/
title: docker/ucp overview
- path: /datacenter/ucp/3.0/reference/cli/backup/
title: backup
- path: /datacenter/ucp/3.0/reference/cli/dump-certs/
title: dump-certs
- path: /datacenter/ucp/3.0/reference/cli/example-config/
title: example-config
- path: /datacenter/ucp/3.0/reference/cli/id/
title: id
- path: /datacenter/ucp/3.0/reference/cli/images/
title: images
- path: /datacenter/ucp/3.0/reference/cli/install/
title: install
- path: /datacenter/ucp/3.0/reference/cli/restart/
title: restart
- path: /datacenter/ucp/3.0/reference/cli/restore/
title: restore
- path: /datacenter/ucp/3.0/reference/cli/stop/
title: stop
- path: /datacenter/ucp/3.0/reference/cli/support/
title: support
- path: /datacenter/ucp/3.0/reference/cli/uninstall-ucp/
title: uninstall-ucp
- path: /datacenter/ucp/3.0/reference/cli/upgrade/
title: upgrade
- sectiontitle: Authorize role-based access - sectiontitle: Authorize role-based access
section: section:
- path: /datacenter/ucp/3.0/guides/authorization/ - path: /datacenter/ucp/3.0/guides/authorization/
@ -1747,8 +1765,6 @@ manuals:
path: /datacenter/ucp/3.0/guides/interlock/ops/ path: /datacenter/ucp/3.0/guides/interlock/ops/
- title: Tuning - title: Tuning
path: /datacenter/ucp/3.0/guides/interlock/ops/tuning/ path: /datacenter/ucp/3.0/guides/interlock/ops/tuning/
- path: /datacenter/ucp/3.0/reference/api/
title: API reference
- path: /datacenter/ucp/3.0/guides/release-notes/ - path: /datacenter/ucp/3.0/guides/release-notes/
title: Release notes title: Release notes
- path: /datacenter/ucp/3.0/guides/get-support/ - path: /datacenter/ucp/3.0/guides/get-support/
@ -2361,27 +2377,6 @@ manuals:
title: Troubleshoot batch jobs title: Troubleshoot batch jobs
- path: /datacenter/dtr/2.5/guides/admin/backups-and-disaster-recovery/ - path: /datacenter/dtr/2.5/guides/admin/backups-and-disaster-recovery/
title: Backups and disaster recovery title: Backups and disaster recovery
- sectiontitle: CLI reference
section:
- path: /datacenter/dtr/2.5/reference/cli/
title: Overview
- path: /datacenter/dtr/2.5/reference/cli/backup/
title: backup
- path: /datacenter/dtr/2.5/reference/cli/destroy/
title: destroy
title: images
- path: /datacenter/dtr/2.5/reference/cli/install/
title: install
- path: /datacenter/dtr/2.5/reference/cli/join/
title: join
- path: /datacenter/dtr/2.5/reference/cli/reconfigure/
title: reconfigure
- path: /datacenter/dtr/2.5/reference/cli/remove/
title: remove
- path: /datacenter/dtr/2.5/reference/cli/restore/
title: restore
- path: /datacenter/dtr/2.5/reference/cli/upgrade/
title: upgrade
- sectiontitle: User guides - sectiontitle: User guides
section: section:
- sectiontitle: Access DTR - sectiontitle: Access DTR
@ -2416,8 +2411,6 @@ manuals:
title: Create and manage webhooks title: Create and manage webhooks
- path: /datacenter/dtr/2.5/guides/user/create-promotion-policies/ - path: /datacenter/dtr/2.5/guides/user/create-promotion-policies/
title: Create promotion policies title: Create promotion policies
- path: /datacenter/dtr/2.5/reference/api/
title: API reference
- path: /datacenter/dtr/2.5/guides/release-notes/ - path: /datacenter/dtr/2.5/guides/release-notes/
title: Release notes title: Release notes
- path: /datacenter/dtr/2.5/guides/support/ - path: /datacenter/dtr/2.5/guides/support/

View File

@ -101,7 +101,7 @@ Where:
This prompts you for the UCP password, backups up the DTR metadata and saves the This prompts you for the UCP password, backups up the DTR metadata and saves the
result into a tar archive. You can learn more about the supported flags in result into a tar archive. You can learn more about the supported flags in
the [reference documentation](../../reference/cli/backup.md). the [reference documentation](/reference/dtr/2.5/cli/backup.md).
The backup command doesn't stop DTR, so that you can take frequent backups The backup command doesn't stop DTR, so that you can take frequent backups
without affecting your users. Also, the backup contains sensitive information without affecting your users. Also, the backup contains sensitive information

View File

@ -52,7 +52,7 @@ You can run that snippet on any node where Docker is installed. As an example
you can SSH into a UCP node and run the DTR installer from there. By default you can SSH into a UCP node and run the DTR installer from there. By default
the installer runs in interactive mode and prompts you for any additional the installer runs in interactive mode and prompts you for any additional
information that is necessary. information that is necessary.
[Learn more about the installer](../../../reference/cli/install.md). [Learn more about the installer](/reference/dtr/2.5/cli/install.md).
By default DTR is deployed with self-signed certificates, so your UCP deployment By default DTR is deployed with self-signed certificates, so your UCP deployment
might not be able to pull images from DTR. might not be able to pull images from DTR.

View File

@ -17,7 +17,7 @@ You will be prompted for the UCP URL, UCP credentials, and which replica to
destroy. destroy.
To see what options are available in the destroy command, check the To see what options are available in the destroy command, check the
[destroy command reference documentation](../../../reference/cli/destroy.md). [destroy command reference documentation](/reference/dtr/2.5/cli/destroy.md).
## Where to go next ## Where to go next

View File

@ -41,7 +41,7 @@ replicas.
## Cluster status ## Cluster status
The `/api/v0/meta/cluster_status` [endpoint](../../../reference/api) The `/api/v0/meta/cluster_status` [endpoint](/reference/dtr/2.5/api/)
requires administrator credentials, and returns a JSON object for the entire requires administrator credentials, and returns a JSON object for the entire
cluster as observed by the replica being queried. You can authenticate your cluster as observed by the replica being queried. You can authenticate your
requests using HTTP basic auth. requests using HTTP basic auth.

View File

@ -73,7 +73,7 @@ $ docker run -it --rm \
By default the upgrade command runs in interactive mode and prompts you for By default the upgrade command runs in interactive mode and prompts you for
any necessary information. You can also check the any necessary information. You can also check the
[reference documentation](../../../reference/cli/index.md) for other existing flags. [reference documentation](/reference/dtr/2.5/cli/index.md) for other existing flags.
The upgrade command will start replacing every container in your DTR cluster, The upgrade command will start replacing every container in your DTR cluster,
one replica at a time. It will also perform certain data migrations. If anything one replica at a time. It will also perform certain data migrations. If anything