Merge pull request #143 from gtardif/docs_jeckyll_metadata

preparing docs for inclusion in docs.docker.com

Author: gtardif

docs/design/design-overview.md

@@ -1,18 +1,24 @@
-#  UI Guidelines
+---
+title: Docker extension design
+description: Docker extension design
+keywords: Docker, extensions, design
+---
 
-Our Design System is currently being developed. In the meantime, here are some basic [UI guidelines](https://www.figma.com/file/U7pLWfEf6IQKUHLhdateBI/Docker-Design-Guidelines?node-id=1%3A28771) you can follow. 
+# UI Guidelines
+
+Our Design System is currently being developed. In the meantime, here are some basic [UI guidelines](https://www.figma.com/file/U7pLWfEf6IQKUHLhdateBI/Docker-Design-Guidelines?node-id=1%3A28771) you can follow.
 
 # Using Docker Material UI Theme
 
-Docker Desktop's UI is written in React and [Material-UI](https://mui.com/). We strongly recommend you  adopt this combination in your extension as well. 
+Docker Desktop's UI is written in React and [Material-UI](https://mui.com/). We strongly recommend you adopt this combination in your extension as well.
 
 Use our [Docker Material UI Theme](https://www.npmjs.com/package/@docker/docker-mui-theme) to easily replicate Docker Desktop's look & feel. We'll continue to release libraries and utilities targeting this combination.
 
 To use [Docker's Material UI theme](https://www.npmjs.com/package/@docker/docker-mui-theme) with your extension, wrap your React app with our theme provider:
 
 ```typescript
-import { DockerMuiThemeProvider } from '@docker/docker-mui-theme';
-import CssBaseline from '@mui/material/CssBaseline';
+import { DockerMuiThemeProvider } from "@docker/docker-mui-theme";
+import CssBaseline from "@mui/material/CssBaseline";
 
 function App() {
   return (
@@ -25,35 +31,33 @@ function App() {
 ```
 
 # Design Principles
+
 At Docker, we aim to build tools that integrate into a user's existing workflows rather than requiring them to adopt new ones. To that end, we recommend the design principles listed below.
 
 ## Clear Call-to-Actions
-When you use call-to-actions (CTAs), use familiar terms that do not have an ambiguous meaning.  Avoid using too many CTAs on one page, wherever possible. If you need to use multiple CTAs, ensure the hierarchy is conveyed through the use of primary and secondary actions.
+
+When you use call-to-actions (CTAs), use familiar terms that do not have an ambiguous meaning. Avoid using too many CTAs on one page, wherever possible. If you need to use multiple CTAs, ensure the hierarchy is conveyed through the use of primary and secondary actions.
 
 Below is an example of the use of a primary (Save) and a secondary (Cancel) button.
 
 ![UI Extension](images/cta-example.png)
 
-
 ## Use the UI
+
 The advantage of Docker Desktop compared to the CLI is the opportunity to provide rich information to users. Make use of this interface as much as possible. Avoid embedding terminal windows if they are not necessary.
 
 ## Build native features
 
-Try to avoid scenarios where the user is redirected to a web page to configure settings or view information, for example.  Build features natively wherever possible to ensure a seamless experience for users.
+Try to avoid scenarios where the user is redirected to a web page to configure settings or view information, for example. Build features natively wherever possible to ensure a seamless experience for users.
 
 ## Break down complicated flows into steps
 
-If a flow is too complicated or the concept is abstract, break down the flow into multiple steps with one simple call-to-action in each step. This helps when onboarding novice users to your extension.  Furthermore, try to provide contextual help instead of redirecting the user to elaborate documentation.
+If a flow is too complicated or the concept is abstract, break down the flow into multiple steps with one simple call-to-action in each step. This helps when onboarding novice users to your extension. Furthermore, try to provide contextual help instead of redirecting the user to elaborate documentation.
 
 ## Visibility of Status
 
-Ensure the current status of the extension is always made visible and clear to users. This helps users feel in control and know what steps they have to take in order to reach their intended outcome.  An example of a status could be “[Extension- name] is connecting to the remote cluster.”
+Ensure the current status of the extension is always made visible and clear to users. This helps users feel in control and know what steps they have to take in order to reach their intended outcome. An example of a status could be “[Extension- name] is connecting to the remote cluster.”
 
-## User-friendly  messages
+## User-friendly messages
 
 When you show messages to the user, for example when an error occurs, avoid the use of detailed technical messages that rely on understanding low-level details. Use simple and concise messages with possible next steps so that a user knows how to remedy the situation.
-
-
-
-

docs/dev/api/backend.md

@@ -1,3 +1,9 @@
+---
+title: Docker extension development API
+description: Docker extension API
+keywords: Docker, extensions, sdk, API
+---
+
 # Communication with the extension backend
 
 The `ddClient.extension.vm` object can be used to communicate with the backend defined in the [vm section](../.. /extensions/METADATA.md#vm-section) of the extension metadata.
@@ -16,11 +22,9 @@ ddClient.extension.vm.service
 
 See [Service API Reference](reference/interfaces/HttpService.md#Methods) for other methods such as POST, UPDATE, and DELETE.
 
-### Deprecated extension backend communication
-
-!!! warning "Methods deprecated"
-
-    The methods below that use `window.ddClient.backend` are deprecated and will be removed in a future version. Use the methods specified above.
+> Deprecated extension backend communication
+>
+> The methods below that use `window.ddClient.backend` are deprecated and will be removed in a future version. Use the methods specified above.
 
 The `window.ddClient.backend` object can be used to communicate with the backend
 defined in the [vm section](../../extensions/METADATA.md#vm-section) of the
@@ -68,7 +72,7 @@ await ddClient.extension.vm.cli.exec("ls", ["-l"]);
 
 Stream the output of the command executed in the backend container. For example, spawn the command `ls -l` inside the backend container:
 
-```typescript linenums="1"
+```typescript
 await ddClient.extension.vm.cli.exec("ls", ["-l"], {
   stream: {
     onOutput(data) {
@@ -90,11 +94,9 @@ await ddClient.extension.vm.cli.exec("ls", ["-l"], {
 
 For more details, refer to the [Extension VM API Reference](reference/interfaces/ExtensionVM.md)
 
-### Deprecated extension backend command execution
-
-!!! warning "Method deprecated"
-
-    This method is deprecated and will be removed in a future version. Use the specified method above.
+> Deprecated extension backend command execution
+>
+> This method is deprecated and will be removed in a future version. Use the specified method above.
 
 If your extension ships with additional binaries that should be run inside the
 backend container, you can use the `execInVMExtension` function:
@@ -119,7 +121,7 @@ await ddClient.extension.host.cli.exec("kubectl", ["-h"]);
 
 As long as the `kubectl` binary is shipped as part of your extension, you can spawn the `kubectl -h` command in the host and get the output stream:
 
-```typescript linenums="1"
+```typescript
 await ddClient.extension.host.cli.exec("kubectl", ["-h"], {
   stream: {
     onOutput(data: { stdout: string } | { stderr: string }): void {
@@ -143,11 +145,9 @@ You can stream the output of the command executed in the backend container or in
 
 For more details, refer to the [Extension Host API Reference](reference/interfaces/ExtensionHost.md)
 
-### Deprecated invocation of extension binary
-
-!!! warning "Method deprecated"
-
-    This method is deprecated and will be removed in a future version. Use the method specified above.
+> Deprecated invocation of extension binary
+>
+> This method is deprecated and will be removed in a future version. Use the method specified above.
 
 To execute a command in the host:
 

docs/dev/api/dashboard-routes-navigation.md

@@ -1,3 +1,9 @@
+---
+title: Docker extension development API
+description: Docker extension API
+keywords: Docker, extensions, sdk, API
+---
+
 # Dashboard Routes Navigation
 
 `ddClient.desktopUI.navigation` enables navigation to specific screens of Docker Desktop such as the containers tab, the images tab, or a specific container's logs.
@@ -22,11 +28,9 @@ A promise that fails if the container doesn't exist.
 
 For more details about all navigation methods, see the [Navigation API reference](reference/interfaces/NavigationIntents.md).
 
-### Deprecated navigation methods
-
-!!! warning "Method deprecated"
-
-    These methdos are deprecated and will be removed in a future version. Use the methods specified above.
+> Deprecated navigation methods
+>
+> These methdos are deprecated and will be removed in a future version. Use the methods specified above.
 
 ```typescript
 window.ddClient.navigateToContainers();

docs/dev/api/dashboard.md

@@ -1,3 +1,9 @@
+---
+title: Docker extension development API
+description: Docker extension API
+keywords: Docker, extensions, sdk, API
+---
+
 ## User notifications
 
 Toasts provide a brief notification to the user. They appear temporarily and
@@ -35,11 +41,9 @@ ddClient.desktopUI.toast.error("message");
 
 For more details about method parameters and the return types available, see [Toast API reference](reference/interfaces/Toast.md).
 
-### Deprecated user notifications
-
-!!! warning "Method deprecated"
-
-    These methods are deprecated and will be removed in a future version. Use the methods specified above.
+> Deprecated user notifications
+>
+> These methods are deprecated and will be removed in a future version. Use the methods specified above.
 
 ```typescript
 window.ddClient.toastSuccess("message");
@@ -74,17 +78,13 @@ This function opens an external URL with the system default browser.
 ddClient.host.openExternal("https://docker.com");
 ```
 
-!!! note
-
-    The URL must have the protocol `http` or `https`.
+> The URL must have the protocol `http` or `https`.
 
 For more details about method parameters and the return types available, see [Desktop host API reference](reference/interfaces/Host.md).
 
-### Deprecated user notifications
-
-!!! warning "Method deprecated"
-
-    This method is deprecated and will be removed in a future version. Use the methods specified above.
+> Deprecated user notifications
+>
+> This method is deprecated and will be removed in a future version. Use the methods specified above.
 
 ```typescript
 window.ddClient.openExternal("https://docker.com");

docs/dev/api/docker.md

@@ -1,3 +1,9 @@
+---
+title: Docker extension development API
+description: Docker extension API
+keywords: Docker, extensions, sdk, API
+---
+
 ## Docker objects
 
 ▸ **listContainers**(`options?`): `Promise`<`unknown`\>
@@ -18,11 +24,9 @@ const images = await ddClient.docker.listImages();
 
 See the [Docker API reference](reference/interfaces/Docker.md) for details about these methods.
 
-### Deprecated access to Docker objects
-
-!!! warning "Method deprecated"
-
-    The methods below are deprecated and will be removed in a future version. Use the methods specified above.
+> Deprecated access to Docker objects
+>
+> The methods below are deprecated and will be removed in a future version. Use the methods specified above.
 
 ```typescript
 const containers = await window.ddClient.listContainers();
@@ -39,7 +43,7 @@ Extensions can also directly execute the `docker` command line.
 ```typescript
 const result = await ddClient.docker.cli.exec("info", [
   "--format",
-  '"{{ json . }}"',
+  {% raw %}'"{{ json . }}"',{% endraw %}
 ]);
 ```
 
@@ -64,7 +68,7 @@ For convenience, the command result object also has methods to easily parse it:
 The command above streams the output as a result of the execution of a docker command.
 This is useful if you need to get the output as a stream or the output of the command is too long.
 
-```typescript linenums="1"
+```typescript
 await ddClient.docker.cli.exec("logs", ["-f", "..."], {
   stream: {
     onOutput(data) {
@@ -88,7 +92,7 @@ await ddClient.docker.cli.exec("logs", ["-f", "..."], {
 The child process created by the extension is killed (`SIGTERM`) automatically when you close the dashboard in Docker Desktop or when you exit the extension UI.
 If needed, you can also use the result of the `exec(streamOptions)` call in order to kill (`SIGTERM`) the process.
 
-```typescript linenums="1"
+```typescript
 const logListener = await ddClient.docker.cli.exec("logs", ["-f", "..."], {
   stream: {
     // ...
@@ -101,10 +105,10 @@ logListener.close();
 
 This `exec(streamOptions)` API can also be used to listen to docker events:
 
-```typescript linenums="1"
+```typescript
 await ddClient.docker.cli.exec(
   "events",
-  ["--format", "{{ json . }}", "--filter", "container=my-container"],
+  {% raw %}["--format", "{{ json . }}", "--filter", "container=my-container"],{% endraw %}
   {
     stream: {
       onOutput(data) {
@@ -126,17 +130,15 @@ await ddClient.docker.cli.exec(
 
 See the [Exec API reference](reference/interfaces/Exec.md) for details about these methods.
 
-### Deprecated execution of Docker commands
-
-!!! warning "Method deprecated"
-
-    This method is deprecated and will be removed in a future version. Use the one specified just below.
+> Deprecated execution of Docker commands
+>
+> This method is deprecated and will be removed in a future version. Use the one specified just below.
 
 ```typescript
 const output = await window.ddClient.execDockerCmd(
   "info",
   "--format",
-  '"{{ json . }}"'
+  {% raw %}'"{{ json . }}"'{% endraw %}
 );
 
 window.ddClient.spawnDockerCmd("logs", ["-f", "..."], (data, error) => {

docs/dev/api/overview.md

@@ -1,3 +1,9 @@
+---
+title: Docker extension development overview
+description: Docker extension development overview
+keywords: Docker, extensions, sdk, development
+---
+
 # Extension UI API
 
 The extensions UI runs in a sandboxed environment and doesn't have access to any