Skip to content

Commit

Permalink
Merge pull request docker#19103 from dvdksn/remove-reading-time-indic…
Browse files Browse the repository at this point in the history
…ator

site: remove "reading time" indicator
  • Loading branch information
dvdksn authored Jan 16, 2024
2 parents f416843 + 28e5641 commit 8c1ad29
Show file tree
Hide file tree
Showing 53 changed files with 47 additions and 106 deletions.
3 changes: 1 addition & 2 deletions content/contribute/file-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ following keys are supported. The title, description, and keywords are required.
| notoc | no | Either `true` or `false`. If `true`, no in-page TOC is generated for the HTML output of this page. Defaults to `false`. Appropriate for some landing pages that have no in-page headings. |
| toc_min | no | Ignored if `notoc` is set to `true`. The minimum heading level included in the in-page TOC. Defaults to `2`, to show `<h2>` headings as the minimum. |
| toc_max | no | Ignored if `notoc` is set to `false`. The maximum heading level included in the in-page TOC. Defaults to `3`, to show `<h3>` headings. Set to the same as `toc_min` to only show `toc_min` level of headings. |
| skip_read_time | no | Set to `true` to disable the 'Estimated reading time' banner for this page. |
| skip_feedback | no | Set to `true` to disable the Feedback widget for this page. |
| sitemap | no | Exclude the page from indexing by search engines. When set to `false`, the page is excluded from `sitemap.xml`, and a `<meta name="robots" content="noindex"/>` header is added to the page. |

Expand Down Expand Up @@ -61,4 +60,4 @@ The body of the page (with the exception of keywords) starts after the front mat

### Text length

Splitting long lines (preferably up to 80 characters) can make it easier to provide feedback on small chunks of text.
Splitting long lines (preferably up to 80 characters) can make it easier to provide feedback on small chunks of text.
3 changes: 1 addition & 2 deletions content/desktop/extensions-sdk/dev/api/reference/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Extensions API Reference
Expand Down Expand Up @@ -36,4 +35,4 @@ skip_read_time: true
- [HttpService](interfaces/HttpService.md)
- [RequestConfig](interfaces/RequestConfig.md)
- [ServiceError](interfaces/ServiceError.md)
- [DockerDesktopClient](interfaces/DockerDesktopClient.md)
- [DockerDesktopClient](interfaces/DockerDesktopClient.md)
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: BackendV0
Expand Down Expand Up @@ -315,4 +314,4 @@ window.ddClient.spawnInVMExtension(

#### Returns

`void`
`void`
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: DesktopUI
Expand All @@ -26,4 +25,4 @@ ___

### navigate

`Readonly` **navigate**: [`NavigationIntents`](NavigationIntents.md)
`Readonly` **navigate**: [`NavigationIntents`](NavigationIntents.md)
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: Dialog
Expand Down Expand Up @@ -32,4 +31,4 @@ ddClient.desktopUI.dialog.showOpenDialog({properties: ['openFile']});

#### Returns

`Promise`<[`OpenDialogResult`](OpenDialogResult.md)\>
`Promise`<[`OpenDialogResult`](OpenDialogResult.md)\>
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: Docker
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: DockerCommand
Expand All @@ -14,4 +13,4 @@ skip_read_time: true

### exec

**exec**: [`Exec`](Exec.md)
**exec**: [`Exec`](Exec.md)
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: DockerDesktopClient
Expand Down Expand Up @@ -718,4 +717,4 @@ window.ddClient.toastError("message");

#### Inherited from

DockerDesktopClientV0.toastError
DockerDesktopClientV0.toastError
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: Exec
Expand Down Expand Up @@ -56,4 +55,4 @@ Specify the `stream` if the output of your command is too long or if you need to

[`ExecProcess`](ExecProcess.md)

The spawned process.
The spawned process.
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: ExecOptions
Expand All @@ -26,4 +25,4 @@ ___

### env

`Optional` **env**: `ProcessEnv`
`Optional` **env**: `ProcessEnv`
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: ExecProcess
Expand All @@ -20,4 +19,4 @@ Close the process started by exec(streamingOptions)

#### Returns

`void`
`void`
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: ExecResult
Expand Down Expand Up @@ -116,4 +115,4 @@ ___

#### Inherited from

[RawExecResult](RawExecResult.md).[stderr](RawExecResult.md#stderr)
[RawExecResult](RawExecResult.md).[stderr](RawExecResult.md#stderr)
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: ExecResultV0
Expand Down Expand Up @@ -82,4 +81,4 @@ Parse a well-formed JSON output.

`any`

The JSON object.
The JSON object.
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: ExecStreamOptions
Expand Down Expand Up @@ -89,4 +88,4 @@ ___

`Optional` `Readonly` **splitOutputLines**: `boolean`

Specifies the behaviour invoking `onOutput(data)`. Raw output by default, splitting output at any position. If set to true, `onOutput` will be invoked once for each line.
Specifies the behaviour invoking `onOutput(data)`. Raw output by default, splitting output at any position. If set to true, `onOutput` will be invoked once for each line.
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: Extension
Expand Down Expand Up @@ -30,4 +29,4 @@ ___

**`Since`**

0.3.3
0.3.3
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: ExtensionCli
Expand All @@ -14,4 +13,4 @@ skip_read_time: true

### exec

**exec**: [`Exec`](Exec.md)
**exec**: [`Exec`](Exec.md)
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: ExtensionHost
Expand Down Expand Up @@ -52,4 +51,4 @@ await ddClient.extension.host.cli.exec("kubectl", ["-h"], {
},
},
});
```
```
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: ExtensionVM
Expand Down Expand Up @@ -76,4 +75,4 @@ ___

### service

`Optional` `Readonly` **service**: [`HttpService`](HttpService.md)
`Optional` `Readonly` **service**: [`HttpService`](HttpService.md)
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: Host
Expand Down Expand Up @@ -70,4 +69,4 @@ Returns the host name of the operating system. See https://nodejs.org/api/os.htm

**`Since`**

0.2.2
0.2.2
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: HttpService
Expand Down Expand Up @@ -179,4 +178,4 @@ ddClient.extension.vm.service
#### Returns
`Promise`<`unknown`\>
`Promise`<`unknown`\>
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: NavigationIntents
Expand Down Expand Up @@ -250,4 +249,4 @@ await ddClient.desktopUI.navigate.viewVolume(volume)

#### Returns

`Promise`<`void`\>
`Promise`<`void`\>
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: OpenDialogResult
Expand Down Expand Up @@ -32,4 +31,4 @@ ___

`Optional` `Readonly` **bookmarks**: `string`[]

macOS only. An array matching the `filePaths` array of `base64` encoded strings which contains security scoped bookmark data. `securityScopedBookmarks` must be enabled for this to be populated.
macOS only. An array matching the `filePaths` array of `base64` encoded strings which contains security scoped bookmark data. `securityScopedBookmarks` must be enabled for this to be populated.
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: RawExecResult
Expand Down Expand Up @@ -50,4 +49,4 @@ ___

### stderr

`Readonly` **stderr**: `string`
`Readonly` **stderr**: `string`
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: RequestConfig
Expand Down Expand Up @@ -32,4 +31,4 @@ ___

### data

`Readonly` **data**: `any`
`Readonly` **data**: `any`
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: RequestConfigV0
Expand All @@ -28,4 +27,4 @@ ___

### data

`Readonly` **data**: `any`
`Readonly` **data**: `any`
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: ServiceError
Expand Down Expand Up @@ -29,4 +28,4 @@ ___

### statusCode

**statusCode**: `number`
**statusCode**: `number`
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
skip_read_time: true
---

# Interface: SpawnOptions
Expand Down Expand Up @@ -40,4 +39,4 @@ ___

### stream

**stream**: [`ExecStreamOptions`](ExecStreamOptions.md)
**stream**: [`ExecStreamOptions`](ExecStreamOptions.md)
Loading

0 comments on commit 8c1ad29

Please sign in to comment.