From 0035868d2ba18aaa4e2c3c577f16302e53949bee Mon Sep 17 00:00:00 2001 From: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Date: Fri, 9 Jun 2023 08:39:23 +0100 Subject: [PATCH] Engdocs 1428 (#17506) * Desktop meta descriptions * compose meta descriptions * checks --- compose/environment-variables/env-file.md | 4 ++-- compose/environment-variables/envvars-precedence.md | 2 +- compose/faq.md | 2 +- compose/file-watch.md | 2 +- compose/gpu-support.md | 2 +- compose/install/uninstall.md | 1 - compose/networking.md | 2 +- compose/profiles.md | 2 +- compose/use-secrets.md | 4 +--- desktop/backup-and-restore.md | 2 +- desktop/faqs/general.md | 2 +- desktop/feedback.md | 4 ++-- desktop/get-started.md | 2 +- desktop/hardened-desktop/enhanced-container-isolation/faq.md | 2 +- .../enhanced-container-isolation/features-benefits.md | 2 +- .../enhanced-container-isolation/how-eci-works.md | 2 +- desktop/hardened-desktop/index.md | 2 +- desktop/hardened-desktop/registry-access-management.md | 2 +- desktop/hardened-desktop/settings-management/configure.md | 2 +- desktop/hardened-desktop/settings-management/index.md | 2 +- desktop/kubernetes.md | 2 +- desktop/mac/permission-requirements.md | 2 +- desktop/networking.md | 2 +- desktop/release-notes.md | 2 +- desktop/settings/linux.md | 2 +- desktop/settings/mac.md | 2 +- desktop/settings/windows.md | 2 +- desktop/support.md | 2 +- desktop/use-desktop/container.md | 2 +- desktop/use-desktop/images.md | 2 +- desktop/use-desktop/index.md | 2 +- desktop/use-desktop/pause.md | 2 +- desktop/use-desktop/volumes.md | 2 +- desktop/windows/permission-requirements.md | 2 +- 34 files changed, 35 insertions(+), 38 deletions(-) diff --git a/compose/environment-variables/env-file.md b/compose/environment-variables/env-file.md index 6c56645b5e..d12757708a 100644 --- a/compose/environment-variables/env-file.md +++ b/compose/environment-variables/env-file.md @@ -1,5 +1,5 @@ --- -description: Declare default environment variables in a file +description: Understand the accepted syntax for declaring environment variables. keywords: fig, composition, compose, docker, orchestration, environment, env file title: Use an environment file redirect_from: @@ -34,7 +34,7 @@ The following syntax rules apply to environment files: - `VAR='some\tvalue'` -> `some\tvalue` - `VAR=some\tvalue` -> `some\tvalue` -### Parameter Expansion +### Parameter expansion Compose supports parameter expansion in environment files. Parameter expansion is applied for unquoted and double-quoted values. Both braced (`${VAR}`) and unbraced (`$VAR`) expressions are supported. diff --git a/compose/environment-variables/envvars-precedence.md b/compose/environment-variables/envvars-precedence.md index e43ca3dfb5..9821ced60a 100644 --- a/compose/environment-variables/envvars-precedence.md +++ b/compose/environment-variables/envvars-precedence.md @@ -1,6 +1,6 @@ --- title: Environment variables precedence -description: Scenario Overview illustrating how environment variables are resolved in Compose +description: Scenario overview illustrating how environment variables are resolved in Compose keywords: compose, environment, env file redirect_from: - /compose/envvars-precedence/ diff --git a/compose/faq.md b/compose/faq.md index dc79002c0d..ff8e0ce6f7 100644 --- a/compose/faq.md +++ b/compose/faq.md @@ -1,5 +1,5 @@ --- -description: Docker Compose FAQ +description: Frequently asked questions for Docker Compose keywords: documentation, docs, docker, compose, faq title: Frequently asked questions --- diff --git a/compose/file-watch.md b/compose/file-watch.md index 28b9af5da4..91712431b8 100644 --- a/compose/file-watch.md +++ b/compose/file-watch.md @@ -1,5 +1,5 @@ --- -description: File watch automatically updates running services as you work +description: Use File watch to automatically update running services as you work keywords: compose, file watch, experimental title: Automatically update services with file watch --- diff --git a/compose/gpu-support.md b/compose/gpu-support.md index 830f0b304d..6eda68db0a 100644 --- a/compose/gpu-support.md +++ b/compose/gpu-support.md @@ -1,5 +1,5 @@ --- -description: GPU support in Compose +description: Understand GPU support in Docker Compose keywords: documentation, docs, docker, compose, GPU access, NVIDIA, samples title: Enabling GPU access with Compose --- diff --git a/compose/install/uninstall.md b/compose/install/uninstall.md index 4b4adf01c2..b4c55c1efb 100644 --- a/compose/install/uninstall.md +++ b/compose/install/uninstall.md @@ -1,7 +1,6 @@ --- description: How to uninstall Docker Compose keywords: compose, orchestration, uninstall, uninstallation, docker, documentation - title: Uninstall Docker Compose --- diff --git a/compose/networking.md b/compose/networking.md index fbcb1ae89c..758c559436 100644 --- a/compose/networking.md +++ b/compose/networking.md @@ -1,5 +1,5 @@ --- -description: How Compose sets up networking between containers +description: How Docker Compose sets up networking between containers keywords: documentation, docs, docker, compose, orchestration, containers, networking title: Networking in Compose --- diff --git a/compose/profiles.md b/compose/profiles.md index 00aa9a87a7..339140256b 100644 --- a/compose/profiles.md +++ b/compose/profiles.md @@ -1,6 +1,6 @@ --- title: Using profiles with Compose -desription: Using profiles with Compose +desription: How to use profiles with Docker Compose keywords: cli, compose, profile, profiles reference --- {% include compose-eol.md %} diff --git a/compose/use-secrets.md b/compose/use-secrets.md index e2703a103c..0e3572ab43 100644 --- a/compose/use-secrets.md +++ b/compose/use-secrets.md @@ -1,5 +1,5 @@ --- -title: Using secrets in Compose +title: How to use secrets in Docker Compose description: How to use secrets in Compose and their benefits keywords: secrets, compose, security, environment variables --- @@ -8,8 +8,6 @@ A secret is any piece of data, such as a password, certificate, or API key, that Docker Compose provides a way for you to use secrets without having to use environment variables to store information. If you’re injecting passwords and API keys as environment variables, you risk unintentional information exposure. Environment variables are often available to all processes, and it can be difficult to track access. They can also be printed in logs when debugging errors without your knowledge. Using secrets mitigates these risks. -Secrets are also useful for locally replicating a remote development setup with Kubernetes. Using secrets makes your application scalable. - ## Use secrets Getting a secret into a container is a two-step process. First, define the secret using the [top-level secrets attribute in your Compose file](compose-file/09-secrets.md). Next, update your service definitions to reference the secrets they require with the [secrets attribute](compose-file/05-services.md#secrets). Compose grants access to secrets on a per-service basis. diff --git a/desktop/backup-and-restore.md b/desktop/backup-and-restore.md index 52c42a845d..c8258d59f5 100644 --- a/desktop/backup-and-restore.md +++ b/desktop/backup-and-restore.md @@ -1,5 +1,5 @@ --- -title: Back up and restore data +title: How to back up and restore your Docker Desktop data keywords: Docker Desktop, backup, restore, migration, reinstall, containers, images, volumes --- diff --git a/desktop/faqs/general.md b/desktop/faqs/general.md index 510ddb2370..58a416c441 100644 --- a/desktop/faqs/general.md +++ b/desktop/faqs/general.md @@ -1,5 +1,5 @@ --- -description: General Frequently asked questions +description: Frequently asked questions for all platforms keywords: desktop, mac, windows, faqs redirect_from: - /mackit/faqs/ diff --git a/desktop/feedback.md b/desktop/feedback.md index 857d378c89..1391f6d1bc 100644 --- a/desktop/feedback.md +++ b/desktop/feedback.md @@ -1,5 +1,5 @@ --- -description: Feedback +description: Find a way to provide feedback that's right for you keywords: Feedback, Docker Desktop, Linux, Mac, Windows, Dev Environments, Extensions, Community forum, bugs, problems, issues title: Give feedback --- @@ -13,7 +13,7 @@ On each Docker Dashboard view, there is a **Give feedback** link. This sends you #### Feedback via Docker Community forums To get help from the community, review current user topics, join or start a -discussion, log on to the appropriate Docker forums: +discussion, sign in to the appropriate Docker forums: - [Docker Desktop for Mac forum](https://forums.docker.com/c/docker-for-mac){:target="_blank" rel="noopener" class="_"} diff --git a/desktop/get-started.md b/desktop/get-started.md index 4d8a577a6f..4875af8c64 100644 --- a/desktop/get-started.md +++ b/desktop/get-started.md @@ -1,5 +1,5 @@ --- -description: Docker Dashboard +description: Explore the Learning center and understand the benefits of signing in to Docker Desktop keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual, learning center, guide, sign in title: Learning Center and sign in redirect_from: diff --git a/desktop/hardened-desktop/enhanced-container-isolation/faq.md b/desktop/hardened-desktop/enhanced-container-isolation/faq.md index 040e469a5f..360466f171 100644 --- a/desktop/hardened-desktop/enhanced-container-isolation/faq.md +++ b/desktop/hardened-desktop/enhanced-container-isolation/faq.md @@ -1,6 +1,6 @@ --- title: FAQs -description: FAQ for Enhanced Container Isolation +description: Frequently asked questions for Enhanced Container Isolation keywords: enhanced container isolation, security, faq, sysbox, Docker Desktop toc_max: 2 --- diff --git a/desktop/hardened-desktop/enhanced-container-isolation/features-benefits.md b/desktop/hardened-desktop/enhanced-container-isolation/features-benefits.md index e46e6c4874..3d171095a0 100644 --- a/desktop/hardened-desktop/enhanced-container-isolation/features-benefits.md +++ b/desktop/hardened-desktop/enhanced-container-isolation/features-benefits.md @@ -1,5 +1,5 @@ --- -description: Instructions on how to set up enhanced container isolation +description: The benefits of enhanced container isolation title: Key features and benefits keywords: set up, enhanced container isolation, rootless, security, features, Docker Desktop --- diff --git a/desktop/hardened-desktop/enhanced-container-isolation/how-eci-works.md b/desktop/hardened-desktop/enhanced-container-isolation/how-eci-works.md index 0503909e15..8ef40677ba 100644 --- a/desktop/hardened-desktop/enhanced-container-isolation/how-eci-works.md +++ b/desktop/hardened-desktop/enhanced-container-isolation/how-eci-works.md @@ -1,5 +1,5 @@ --- -description: Instructions on how to set up enhanced container isolation +description: How Enhanced Container Isolation works title: How does it work? keywords: set up, enhanced container isolation, rootless, security --- diff --git a/desktop/hardened-desktop/index.md b/desktop/hardened-desktop/index.md index 9387c68113..017aae994f 100644 --- a/desktop/hardened-desktop/index.md +++ b/desktop/hardened-desktop/index.md @@ -1,6 +1,6 @@ --- title: Hardened Docker Desktop -description: Overview of what Hardened Docker Desktop is +description: Overview of what Hardened Docker Desktop is and its key features keywords: security, hardened desktop, enhanced container isolation, registry access management, settings management root access, admins, docker desktop, image access management --- >Note diff --git a/desktop/hardened-desktop/registry-access-management.md b/desktop/hardened-desktop/registry-access-management.md index 526c2249be..9af10417af 100644 --- a/desktop/hardened-desktop/registry-access-management.md +++ b/desktop/hardened-desktop/registry-access-management.md @@ -1,5 +1,5 @@ --- -description: Registry Access Management +description: What Registry Access Management is and how to use it keywords: registry access managment, Hardened Docker Desktop, Docker Desktop, images, Docker Hub title: Registry Access Management redirect_from: diff --git a/desktop/hardened-desktop/settings-management/configure.md b/desktop/hardened-desktop/settings-management/configure.md index 58fd88fe92..36de66bfb3 100644 --- a/desktop/hardened-desktop/settings-management/configure.md +++ b/desktop/hardened-desktop/settings-management/configure.md @@ -1,5 +1,5 @@ --- -description: settings management for desktop +description: How to configure Settings Management for Docker Desktop keywords: admin, controls, rootless, enhanced container isolation title: Configure Settings Management --- diff --git a/desktop/hardened-desktop/settings-management/index.md b/desktop/hardened-desktop/settings-management/index.md index 3c9950d063..fc4b536ac9 100644 --- a/desktop/hardened-desktop/settings-management/index.md +++ b/desktop/hardened-desktop/settings-management/index.md @@ -1,5 +1,5 @@ --- -description: Settings Management for desktop +description: Understand how Settings Management works, who it is for, and what the benefits are keywords: Settings Management, rootless, docker desktop, hardened desktop title: What is Settings Management? --- diff --git a/desktop/kubernetes.md b/desktop/kubernetes.md index 0f85b2cd48..4d2a4564f0 100644 --- a/desktop/kubernetes.md +++ b/desktop/kubernetes.md @@ -1,5 +1,5 @@ --- -description: Deploying to Kubernetes on Docker Desktop +description: See how you can deploy to Kubernetes on Docker Desktop keywords: deploy, kubernetes, kubectl, orchestration, Docker Desktop title: Deploy on Kubernetes redirect_from: diff --git a/desktop/mac/permission-requirements.md b/desktop/mac/permission-requirements.md index 84ac356b9d..e650ed755b 100644 --- a/desktop/mac/permission-requirements.md +++ b/desktop/mac/permission-requirements.md @@ -1,5 +1,5 @@ --- -description: Permission requirements for Docker Desktop for Mac +description: Understand permission requirements for Docker Desktop for Mac and the differences between versions keywords: Docker Desktop, mac, security, install, permissions title: Understand permission requirements for Mac redirect_from: diff --git a/desktop/networking.md b/desktop/networking.md index 0bf3380175..9e64700f9a 100644 --- a/desktop/networking.md +++ b/desktop/networking.md @@ -1,5 +1,5 @@ --- -description: Networking on Docker Desktop +description: Understand how networking works on Docker Desktop and see the known limitations keywords: networking, docker desktop, proxy, vpn, Linux, Mac, Windows title: Explore networking features redirect_from: diff --git a/desktop/release-notes.md b/desktop/release-notes.md index e4d0fe7c3e..2d3616c8ad 100644 --- a/desktop/release-notes.md +++ b/desktop/release-notes.md @@ -1,5 +1,5 @@ --- -description: Release notes for Docker Desktop for Mac, Linux, Windows +description: Release notes for Docker Desktop for Mac, Linux, and Windows keywords: Docker desktop, release notes, linux, mac, windows title: Docker Desktop release notes toc_max: 2 diff --git a/desktop/settings/linux.md b/desktop/settings/linux.md index 626689d8ee..14ad125740 100644 --- a/desktop/settings/linux.md +++ b/desktop/settings/linux.md @@ -1,5 +1,5 @@ --- -description: Docker Desktop settings +description: Change your Docker Desktop settings on Linux keywords: settings, preferences, proxy, file sharing, resources, kubernetes, Docker Desktop, Linux title: Change on Linux --- diff --git a/desktop/settings/mac.md b/desktop/settings/mac.md index e7443800b0..1badbe3d79 100644 --- a/desktop/settings/mac.md +++ b/desktop/settings/mac.md @@ -1,5 +1,5 @@ --- -description: Docker Desktop settings +description: Change your Docker Desktop settings on Mac keywords: settings, preferences, proxy, file sharing, resources, kubernetes, Docker Desktop, Mac title: Change preferences on Mac redirect_from: diff --git a/desktop/settings/windows.md b/desktop/settings/windows.md index c2d922d584..9ca51ccb58 100644 --- a/desktop/settings/windows.md +++ b/desktop/settings/windows.md @@ -1,5 +1,5 @@ --- -description: Docker Desktop settings +description: Change your Docker Desktop settings on Windows keywords: settings, preferences, proxy, file sharing, resources, kubernetes, Docker Desktop, Windows title: Change Docker Desktop settings on Windows --- diff --git a/desktop/support.md b/desktop/support.md index e88ef4f3ea..3d0d110912 100644 --- a/desktop/support.md +++ b/desktop/support.md @@ -1,5 +1,5 @@ --- -description: Docker Desktop support +description: See what support is available for Docker Desktop keywords: Support, Docker Desktop, Linux, Mac, Windows title: Get support --- diff --git a/desktop/use-desktop/container.md b/desktop/use-desktop/container.md index 9f2b58ed1b..e19967b3b8 100644 --- a/desktop/use-desktop/container.md +++ b/desktop/use-desktop/container.md @@ -1,5 +1,5 @@ --- -description: Docker Dashboard +description: Understand what you can do with the Containers view on Docker Dashboard keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual title: Explore Containers --- diff --git a/desktop/use-desktop/images.md b/desktop/use-desktop/images.md index b1e0d63c83..cc5ceaa22c 100644 --- a/desktop/use-desktop/images.md +++ b/desktop/use-desktop/images.md @@ -1,5 +1,5 @@ --- -description: Docker Dashboard +description: Understand what you can do with the Images view on Docker Dashboard keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual title: Explore Images --- diff --git a/desktop/use-desktop/index.md b/desktop/use-desktop/index.md index 44796e87c5..f35efd4645 100644 --- a/desktop/use-desktop/index.md +++ b/desktop/use-desktop/index.md @@ -1,5 +1,5 @@ --- -description: Docker Dashboard +description: Understand what you can do with Docker Dashboard keywords: Docker Dashboard, manage, containers, gui, dashboard, images, user manual, whale menu title: Overview redirect_from: diff --git a/desktop/use-desktop/pause.md b/desktop/use-desktop/pause.md index 01a74dce26..e5f41f8635 100644 --- a/desktop/use-desktop/pause.md +++ b/desktop/use-desktop/pause.md @@ -1,5 +1,5 @@ --- -description: Pause Docker Dashboard +description: understand what pausing Docker Dashboard means keywords: Docker Dashboard, manage, containers, gui, dashboard, pause, user manual title: Pause Docker Desktop --- diff --git a/desktop/use-desktop/volumes.md b/desktop/use-desktop/volumes.md index 62b81871ff..8fb00b8f04 100644 --- a/desktop/use-desktop/volumes.md +++ b/desktop/use-desktop/volumes.md @@ -1,5 +1,5 @@ --- -description: Docker Dashboard +description: Understand what you can do with the Volumes view on Docker Dashboard keywords: Docker Dashboard, manage, containers, gui, dashboard, volumes, user manual title: Explore Volumes --- diff --git a/desktop/windows/permission-requirements.md b/desktop/windows/permission-requirements.md index 18e93aec7b..60196f5ffd 100644 --- a/desktop/windows/permission-requirements.md +++ b/desktop/windows/permission-requirements.md @@ -1,5 +1,5 @@ --- -description: Permission requirements for Docker Desktop for Windows +description: Understand permission requirements for Docker Desktop for Windows keywords: Docker Desktop, Windows, security, install title: Understand permission requirements for Windows redirect_from: