Skip to content

Commit e4468ec

Browse files
committed
docs: recreate config partials
1 parent c4a14d3 commit e4468ec

663 files changed

Lines changed: 11413 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
import PartialCommandsreference from "./commands_reference.mdx"
3+
4+
5+
<details className="config-field" data-expandable="true" open>
6+
<summary>
7+
8+
## `commands` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">&lt;command_name&gt;:object</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands}
9+
10+
Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash
11+
that also allows executing special commands such as run_watch or is_equal.
12+
13+
</summary>
14+
15+
16+
<details className="config-field" data-expandable="true"open>
17+
<summary>
18+
19+
## `<command_name>` <span className="config-field-required" data-required="true">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-name}
20+
21+
Name is the name of a command that is used via `devspace run NAME`
22+
23+
</summary>
24+
25+
<PartialCommandsreference />
26+
27+
28+
</details>
29+
30+
31+
</details>
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
### `after` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-after}
6+
7+
After is executed after the command was run. It is executed also when
8+
the command was interrupted which will set the env variable COMMAND_INTERRUPT
9+
to true as well as when the command errored which will set the error string to
10+
COMMAND_ERROR.
11+
12+
</summary>
13+
14+
15+
16+
</details>
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
### `appendArgs` <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> {#commands-appendArgs}
6+
7+
AppendArgs will append arguments passed to the DevSpace command automatically to
8+
the specified command.
9+
10+
</summary>
11+
12+
13+
14+
</details>
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
<details className="config-field" data-expandable="false" open>
3+
<summary>
4+
5+
### `args` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string[]</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-args}
6+
7+
Args are optional and if defined, command is not executed within a shell
8+
and rather directly.
9+
10+
</summary>
11+
12+
13+
14+
</details>
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+
### `command` <span className="config-field-required" data-required="true">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-command}
6+
7+
Command is the command that should be executed. For example: 'echo 123'
8+
9+
</summary>
10+
11+
12+
13+
</details>
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+
### `description` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#commands-description}
6+
7+
Description describes what the command is doing and can be seen in `devspace list commands`
8+
9+
</summary>
10+
11+
12+
13+
</details>
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+
### `internal` <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> {#commands-internal}
6+
7+
Internal commands are not show in list and are usable through run_command
8+
9+
</summary>
10+
11+
12+
13+
</details>
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
2+
import PartialCommand from "./commands/command.mdx"
3+
import PartialArgs from "./commands/args.mdx"
4+
import PartialAppendArgs from "./commands/appendArgs.mdx"
5+
import PartialDescription from "./commands/description.mdx"
6+
import PartialInternal from "./commands/internal.mdx"
7+
import PartialAfter from "./commands/after.mdx"
8+
9+
<PartialCommand />
10+
11+
12+
<PartialArgs />
13+
14+
15+
<PartialAppendArgs />
16+
17+
18+
<PartialDescription />
19+
20+
21+
<PartialInternal />
22+
23+
24+
<PartialAfter />
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
import PartialDependenciesreference from "./dependencies_reference.mdx"
3+
4+
5+
<details className="config-field" data-expandable="true" open>
6+
<summary>
7+
8+
## `dependencies` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">&lt;dependency_name&gt;:object</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dependencies}
9+
10+
Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed
11+
from within the pipeline. In contrast to imports, these projects pose as separate fully functional DevSpace projects
12+
that typically lie including source code in a different folder and can be used to compose a full microservice
13+
application that will be deployed by DevSpace. Each dependency name can only be used once and if you want to use
14+
the same project multiple times, make sure to use a different name for each of those instances.
15+
16+
</summary>
17+
18+
19+
<details className="config-field" data-expandable="true"open>
20+
<summary>
21+
22+
## `<dependency_name>` <span className="config-field-required" data-required="true">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dependencies-name}
23+
24+
Name is used internally
25+
26+
</summary>
27+
28+
<PartialDependenciesreference />
29+
30+
31+
</details>
32+
33+
34+
</details>
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+
### `branch` <span className="config-field-required" data-required="false">required</span> <span className="config-field-type">string</span> <span className="config-field-default"></span> <span className="config-field-enum"></span> {#dependencies-branch}
6+
7+
Branch is the git branch to pull
8+
9+
</summary>
10+
11+
12+
13+
</details>

0 commit comments

Comments
 (0)