Skip to content

Commit 26a6904

Browse files
LukasGenteleLukasGentele
committed
docs: update partials
1 parent 8e32112 commit 26a6904

386 files changed

Lines changed: 1370 additions & 1515 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.

‎docs/hack/config/partials/main.go‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ const nameFieldName = "name"
2121
const versionFieldName = "version"
2222
const groupKey = "group"
2323
const groupNameKey = "group_name"
24+
const prefixSeparator = "/"
25+
const anchorSeparator = "-"
2426

2527
var pluralizeClient = pluralize.NewClient()
2628

@@ -81,6 +83,7 @@ func createSections(prefix string, schema *jsonschema.Schema, definitions jsonsc
8183
partialImports := &[]string{}
8284
content := ""
8385
headlinePrefix := strings.Repeat("#", depth+1) + " "
86+
anchorPrefix := strings.TrimPrefix(strings.ReplaceAll(prefix, prefixSeparator, anchorSeparator), anchorSeparator)
8487

8588
groups := map[string]*Group{}
8689

@@ -117,7 +120,7 @@ func createSections(prefix string, schema *jsonschema.Schema, definitions jsonsc
117120
nestedSchema, ok = definitions[refSplit[len(refSplit)-1]]
118121

119122
if ok {
120-
newPrefix := prefix + fieldName + "/"
123+
newPrefix := prefix + fieldName + prefixSeparator
121124
createSections(newPrefix, nestedSchema, definitions, depth+1, isNameObjectMap)
122125
}
123126
} else {
@@ -164,7 +167,8 @@ func createSections(prefix string, schema *jsonschema.Schema, definitions jsonsc
164167

165168
enumValues := GetEumValues(fieldSchema, required, &fieldDefault)
166169

167-
fieldContent = fmt.Sprintf(util.TemplateConfigField, false, " open", headlinePrefix, fieldName, required, fieldType, fieldDefault, enumValues, fieldSchema.Description, "")
170+
anchorName := anchorPrefix + fieldName
171+
fieldContent = fmt.Sprintf(util.TemplateConfigField, false, " open", headlinePrefix, fieldName, required, fieldType, fieldDefault, enumValues, anchorName, fieldSchema.Description, "")
168172

169173
err := os.MkdirAll(filepath.Dir(fieldFile), os.ModePerm)
170174
if err != nil {
@@ -188,13 +192,15 @@ func createSections(prefix string, schema *jsonschema.Schema, definitions jsonsc
188192
nameFieldDefault := ""
189193
nameFieldEnumValues := GetEumValues(nameFieldSchema, nameFieldRequired, &nameFieldDefault)
190194

191-
fieldPartial = fmt.Sprintf(util.TemplateConfigField, true, "open", headlinePrefix, "<"+fieldNameSingular+"_"+nameFieldName+">", nameFieldRequired, "string", nameFieldDefault, nameFieldEnumValues, nameFieldSchema.Description, fieldPartial)
195+
anchorName := anchorPrefix + nameFieldName
196+
fieldPartial = fmt.Sprintf(util.TemplateConfigField, true, "open", headlinePrefix, "<"+fieldNameSingular+"_"+nameFieldName+">", nameFieldRequired, "string", nameFieldDefault, nameFieldEnumValues, anchorName, nameFieldSchema.Description, fieldPartial)
192197
fieldType = "&lt;" + fieldNameSingular + "_name&gt;:object"
193198
}
194199
}
195200
}
196201

197-
fieldPartial = fmt.Sprintf(util.TemplateConfigField, true, "", headlinePrefix, fieldName, false, fieldType, "", "", fieldSchema.Description, fieldPartial)
202+
anchorName := anchorPrefix + fieldName
203+
fieldPartial = fmt.Sprintf(util.TemplateConfigField, true, "", headlinePrefix, fieldName, false, fieldType, "", "", anchorName, fieldSchema.Description, fieldPartial)
198204
}
199205

200206
if groupID != "" {

‎docs/hack/util/templates.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const TemplateConfigField = `
3939
<details className="config-field" data-expandable="%t"%s>
4040
<summary>
4141
42-
%s` + "`%s`" + ` <span class="config-field-required" data-required="%t">required</span> <span class="config-field-type">%s</span> <span class="config-field-default">%s</span> <span class="config-field-enum">%s</span>
42+
%s` + "`%s`" + ` <span class="config-field-required" data-required="%t">required</span> <span class="config-field-type">%s</span> <span class="config-field-default">%s</span> <span class="config-field-enum">%s</span> {#%s}
4343
4444
%s
4545

‎docs/pages/configuration/_partials/v2beta1/commands/after.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<details className="config-field" data-expandable="false" open>
33
<summary>
44

5-
### `after` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">string</span> <span class="config-field-default"></span> <span class="config-field-enum"></span>
5+
### `after` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">string</span> <span class="config-field-default"></span> <span class="config-field-enum"></span> {#commands-after}
66

77
After is executed after the command was run. It is executed also when
88
the command was interrupted which will set the env variable COMMAND_INTERRUPT

‎docs/pages/configuration/_partials/v2beta1/commands/appendArgs.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<details className="config-field" data-expandable="false" open>
33
<summary>
44

5-
### `appendArgs` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">boolean</span> <span class="config-field-default">false</span> <span class="config-field-enum"></span>
5+
### `appendArgs` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">boolean</span> <span class="config-field-default">false</span> <span class="config-field-enum"></span> {#commands-appendArgs}
66

77
AppendArgs will append arguments passed to the DevSpace command automatically to
88
the specified command.

‎docs/pages/configuration/_partials/v2beta1/commands/args.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<details className="config-field" data-expandable="false" open>
33
<summary>
44

5-
### `args` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">string[]</span> <span class="config-field-default"></span> <span class="config-field-enum"></span>
5+
### `args` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">string[]</span> <span class="config-field-default"></span> <span class="config-field-enum"></span> {#commands-args}
66

77
Args are optional and if defined, command is not executed within a shell
88
and rather directly.

‎docs/pages/configuration/_partials/v2beta1/commands/command.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<details className="config-field" data-expandable="false" open>
33
<summary>
44

5-
### `command` <span class="config-field-required" data-required="true">required</span> <span class="config-field-type">string</span> <span class="config-field-default"></span> <span class="config-field-enum"></span>
5+
### `command` <span class="config-field-required" data-required="true">required</span> <span class="config-field-type">string</span> <span class="config-field-default"></span> <span class="config-field-enum"></span> {#commands-command}
66

77
Command is the command that should be executed. For example: 'echo 123'
88

‎docs/pages/configuration/_partials/v2beta1/commands/description.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<details className="config-field" data-expandable="false" open>
33
<summary>
44

5-
### `description` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">string</span> <span class="config-field-default"></span> <span class="config-field-enum"></span>
5+
### `description` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">string</span> <span class="config-field-default"></span> <span class="config-field-enum"></span> {#commands-description}
66

77
Description describes what the command is doing and can be seen in `devspace list commands`
88

‎docs/pages/configuration/_partials/v2beta1/commands/internal.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<details className="config-field" data-expandable="false" open>
33
<summary>
44

5-
### `internal` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">boolean</span> <span class="config-field-default">false</span> <span class="config-field-enum"></span>
5+
### `internal` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">boolean</span> <span class="config-field-default">false</span> <span class="config-field-enum"></span> {#commands-internal}
66

77
Internal commands are not show in list and are usable through run_command
88

‎docs/pages/configuration/_partials/v2beta1/dependencies.mdx‎

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,12 @@
11

22
import PartialGrouppath from "./dependencies/group_path.mdx"
33
import PartialGroupgit from "./dependencies/group_git.mdx"
4-
import PartialPipeline from "./dependencies/pipeline.mdx"
5-
import PartialVars from "./dependencies/vars.mdx"
6-
import PartialOverwriteVars from "./dependencies/overwriteVars.mdx"
7-
import PartialIgnoreDependencies from "./dependencies/ignoreDependencies.mdx"
8-
import PartialNamespace from "./dependencies/namespace.mdx"
4+
import PartialGroupexecution from "./dependencies/group_execution.mdx"
95

106
<PartialGrouppath />
117

128

139
<PartialGroupgit />
1410

1511

16-
<PartialPipeline />
17-
18-
19-
<PartialVars />
20-
21-
22-
<PartialOverwriteVars />
23-
24-
25-
<PartialIgnoreDependencies />
26-
27-
28-
<PartialNamespace />
12+
<PartialGroupexecution />

‎docs/pages/configuration/_partials/v2beta1/dependencies/branch.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<details className="config-field" data-expandable="false" open>
33
<summary>
44

5-
### `branch` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">string</span> <span class="config-field-default"></span> <span class="config-field-enum"></span>
5+
### `branch` <span class="config-field-required" data-required="false">required</span> <span class="config-field-type">string</span> <span class="config-field-default"></span> <span class="config-field-enum"></span> {#dependencies-branch}
66

77
Branch is the git branch to pull
88

0 commit comments

Comments
 (0)