From bad33315972a3a616425a3d84a0bc2daef96aaff Mon Sep 17 00:00:00 2001 From: Oliver Nocon <33484802+OliverNocon@users.noreply.github.com> Date: Fri, 17 Dec 2021 08:45:21 +0100 Subject: [PATCH] doc: fix rendering of stage overview (#3371) --- pkg/documentation/generator/main.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pkg/documentation/generator/main.go b/pkg/documentation/generator/main.go index 5e0cb19a1..0d8737460 100644 --- a/pkg/documentation/generator/main.go +++ b/pkg/documentation/generator/main.go @@ -279,10 +279,10 @@ func createPipelineOverviewDocumentation(stageRunConfig *config.RunConfigV1, sta overviewFileName := "overview.md" overviewDoc := fmt.Sprintf("# %v\n\n", stageRunConfig.PipelineConfig.Metadata.DisplayName) overviewDoc += fmt.Sprintf("%v\n\n", stageRunConfig.PipelineConfig.Metadata.Description) - overviewDoc += fmt.Sprintf("The %v comprises following stages\n\n", stageRunConfig.PipelineConfig.Metadata.Description) + overviewDoc += fmt.Sprintf("The %v comprises following stages\n\n", stageRunConfig.PipelineConfig.Metadata.DisplayName) for _, stage := range stageRunConfig.PipelineConfig.Spec.Stages { stageFilePath := filepath.Join(stageTargetPath, fmt.Sprintf("%v.md", stage.Name)) - overviewDoc += fmt.Sprintf("* [%v Stage](%v)", stage.DisplayName, stageFilePath) + overviewDoc += fmt.Sprintf("* [%v Stage](%v)\n", stage.DisplayName, stageFilePath) } overviewFilePath := filepath.Join(stageTargetPath, overviewFileName) fmt.Println("writing file", overviewFilePath) @@ -292,8 +292,8 @@ func createPipelineOverviewDocumentation(stageRunConfig *config.RunConfigV1, sta const stepConditionDetails = `!!! note "Step condition details" There are currently several conditions which can be checked.
**Important: It will be sufficient that any one condition per step is met.** - * ` + "`" + `config` + "`" + `: Checks if a defined configuration parameter is set. - * ` + "`" + `config value` + "`" + `: Checks if a configuration parameter has a defined value. + * ` + "`" + `config` + "`" + `: Checks if a configuration parameter has a defined value. + * ` + "`" + `config key` + "`" + `: Checks if a defined configuration parameter is set. * ` + "`" + `file pattern` + "`" + `: Checks if files according a defined pattern exist in the project. * ` + "`" + `file pattern from config` + "`" + `: Checks if files according a pattern defined in the custom configuration exist in the project. * ` + "`" + `npm script` + "`" + `: Checks if a npm script exists in one of the package.json files in the repositories.