Skip to content

Commit 0cf333e

Browse files
FabianKrammFabianKramm
committed
docs: update schema / partials
1 parent b0b323e commit 0cf333e

17 files changed

Lines changed: 126 additions & 84 deletions

‎docs/pages/configuration/_partials/v2beta1/dev/containers/group_modifications.mdx‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import PartialArgs from "./args.mdx"
55
import PartialWorkingDir from "./workingDir.mdx"
66
import PartialEnvreference from "./env_reference.mdx"
77
import PartialResourcesreference from "./resources_reference.mdx"
8-
import PartialPersistPathsreference from "./persistPaths_reference.mdx"
98

109
<div className="group" data-group="modifications">
1110
<div className="group-name">Modifications</div>
@@ -41,20 +40,6 @@ Resources can be used to override the resource definitions of the container.
4140
<PartialResourcesreference />
4241

4342

44-
</details>
45-
46-
<details className="config-field" data-expandable="true">
47-
<summary>
48-
49-
#### `persistPaths` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">object[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-persistPaths}
50-
51-
SSH allows you to create an SSH tunnel to this container.
52-
53-
</summary>
54-
55-
<PartialPersistPathsreference />
56-
57-
5843
</details>
5944

6045
</div>

‎docs/pages/configuration/_partials/v2beta1/dev/containers/group_workflows_background.mdx‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,11 @@
11

2-
import PartialSshreference from "./ssh_reference.mdx"
32
import PartialProxyCommandsreference from "./proxyCommands_reference.mdx"
43
import PartialRestartHelperreference from "./restartHelper_reference.mdx"
54

65
<div className="group" data-group="workflows_background">
76
<details className="config-field" data-expandable="true">
87
<summary>
98

10-
#### `ssh` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-ssh}
11-
12-
PersistPaths allows you to persist certain paths within this container with a persistent volume claim.
13-
14-
</summary>
15-
16-
<PartialSshreference />
17-
18-
19-
</details>
20-
21-
<details className="config-field" data-expandable="true">
22-
<summary>
23-
249
#### `proxyCommands` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">object[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-proxyCommands}
2510

2611
ProxyCommands allow you to proxy certain local commands to the container.

‎docs/pages/configuration/_partials/v2beta1/dev/containers/persistPaths.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import PartialPersistPathsreference from "./persistPaths_reference.mdx"
77

88
#### `persistPaths` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">object[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-persistPaths}
99

10-
SSH allows you to create an SSH tunnel to this container.
10+
PersistPaths allows you to persist certain paths within this container with a persistent volume claim
1111

1212
</summary>
1313

‎docs/pages/configuration/_partials/v2beta1/dev/containers/ssh.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import PartialSshreference from "./ssh_reference.mdx"
77

88
#### `ssh` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-ssh}
99

10-
PersistPaths allows you to persist certain paths within this container with a persistent volume claim.
10+
SSH allows you to create an SSH tunnel to this container
1111

1212
</summary>
1313

‎docs/pages/configuration/_partials/v2beta1/dev/containers/ssh/useInclude.mdx‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
##### `useInclude` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">boolean</span> <span className="config-field-default">false</span> <span className="config-field-enum"></span> {#dev-containers-ssh-useInclude}
6+
7+
UseInclude tells DevSpace to use a different file for ssh config
8+
9+
</summary>
10+
11+
12+
13+
</details>

‎docs/pages/configuration/_partials/v2beta1/dev/containers/ssh_reference.mdx‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ import PartialEnabled from "./ssh/enabled.mdx"
33
import PartialLocalHostname from "./ssh/localHostname.mdx"
44
import PartialLocalPort from "./ssh/localPort.mdx"
55
import PartialRemoteAddress from "./ssh/remoteAddress.mdx"
6+
import PartialUseInclude from "./ssh/useInclude.mdx"
67

78
<PartialEnabled />
89

@@ -14,3 +15,6 @@ import PartialRemoteAddress from "./ssh/remoteAddress.mdx"
1415

1516

1617
<PartialRemoteAddress />
18+
19+
20+
<PartialUseInclude />

‎docs/pages/configuration/_partials/v2beta1/dev/containers_reference.mdx‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ import PartialGroupselector from "./containers/group_selector.mdx"
33
import PartialGroupmodifications from "./containers/group_modifications.mdx"
44
import PartialGroupports from "./containers/group_ports.mdx"
55
import PartialGroupsync from "./containers/group_sync.mdx"
6+
import PartialPersistPathsreference from "./containers/persistPaths_reference.mdx"
67
import PartialGroupworkflows from "./containers/group_workflows.mdx"
8+
import PartialSshreference from "./containers/ssh_reference.mdx"
79
import PartialGroupworkflowsbackground from "./containers/group_workflows_background.mdx"
810

911
<PartialGroupselector />
@@ -18,7 +20,39 @@ import PartialGroupworkflowsbackground from "./containers/group_workflows_backgr
1820
<PartialGroupsync />
1921

2022

23+
24+
<details className="config-field" data-expandable="true">
25+
<summary>
26+
27+
#### `persistPaths` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">object[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-persistPaths}
28+
29+
PersistPaths allows you to persist certain paths within this container with a persistent volume claim
30+
31+
</summary>
32+
33+
<PartialPersistPathsreference />
34+
35+
36+
</details>
37+
38+
2139
<PartialGroupworkflows />
2240

2341

42+
43+
<details className="config-field" data-expandable="true">
44+
<summary>
45+
46+
#### `ssh` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-containers-ssh}
47+
48+
SSH allows you to create an SSH tunnel to this container
49+
50+
</summary>
51+
52+
<PartialSshreference />
53+
54+
55+
</details>
56+
57+
2458
<PartialGroupworkflowsbackground />

‎docs/pages/configuration/_partials/v2beta1/dev/group_modifications.mdx‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import PartialArgs from "./args.mdx"
55
import PartialWorkingDir from "./workingDir.mdx"
66
import PartialEnvreference from "./env_reference.mdx"
77
import PartialResourcesreference from "./resources_reference.mdx"
8-
import PartialPersistPathsreference from "./persistPaths_reference.mdx"
98
import PartialPersistenceOptionsreference from "./persistenceOptions_reference.mdx"
109
import PartialPatchesreference from "./patches_reference.mdx"
1110

@@ -43,20 +42,6 @@ Resources can be used to override the resource definitions of the container.
4342
<PartialResourcesreference />
4443

4544

46-
</details>
47-
48-
<details className="config-field" data-expandable="true">
49-
<summary>
50-
51-
### `persistPaths` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">object[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-persistPaths}
52-
53-
SSH allows you to create an SSH tunnel to this container.
54-
55-
</summary>
56-
57-
<PartialPersistPathsreference />
58-
59-
6045
</details>
6146

6247
<details className="config-field" data-expandable="true">

‎docs/pages/configuration/_partials/v2beta1/dev/group_workflows_background.mdx‎

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11

2-
import PartialSshreference from "./ssh_reference.mdx"
32
import PartialProxyCommandsreference from "./proxyCommands_reference.mdx"
43
import PartialRestartHelperreference from "./restartHelper_reference.mdx"
54
import PartialOpenreference from "./open_reference.mdx"
@@ -8,20 +7,6 @@ import PartialOpenreference from "./open_reference.mdx"
87
<div className="group-name">Background Dev Workflows</div>
98

109

11-
<details className="config-field" data-expandable="true">
12-
<summary>
13-
14-
### `ssh` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type"></span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-ssh}
15-
16-
PersistPaths allows you to persist certain paths within this container with a persistent volume claim.
17-
18-
</summary>
19-
20-
<PartialSshreference />
21-
22-
23-
</details>
24-
2510
<details className="config-field" data-expandable="true">
2611
<summary>
2712

‎docs/pages/configuration/_partials/v2beta1/dev/persistPaths.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import PartialPersistPathsreference from "./persistPaths_reference.mdx"
77

88
### `persistPaths` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">object[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dev-persistPaths}
99

10-
SSH allows you to create an SSH tunnel to this container.
10+
PersistPaths allows you to persist certain paths within this container with a persistent volume claim
1111

1212
</summary>
1313

0 commit comments

Comments
 (0)