Skip to content

Commit a242bca

Browse files
authored
fix(docs): remove dead links (#5051)
* fix(docs): remove dead links * Update parameters_test.go
1 parent 528a72e commit a242bca

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

pkg/documentation/generator/parameters.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ import (
1010
)
1111

1212
const (
13-
vaultBadge = "[Vault](https://img.shields.io/badge/-Vault-lightgrey)"
14-
jenkinsOnlyBadge = "[Jenkins only](https://img.shields.io/badge/-Jenkins%20only-yellowgreen)"
15-
secretBadge = "[Secret](https://img.shields.io/badge/-Secret-yellowgreen)"
16-
trustengineBadge = "[Trust Engine](https://img.shields.io/badge/-Trust Engine-lightblue)"
17-
deprecatedBadge = "[deprecated](https://img.shields.io/badge/-deprecated-red)"
13+
vaultBadge = "![Vault](https://img.shields.io/badge/-Vault-lightgrey)"
14+
jenkinsOnlyBadge = "![Jenkins only](https://img.shields.io/badge/-Jenkins%20only-yellowgreen)"
15+
secretBadge = "![Secret](https://img.shields.io/badge/-Secret-yellowgreen)"
16+
trustengineBadge = "![Trust Engine](https://img.shields.io/badge/-Trust%20Engine-lightblue)"
17+
deprecatedBadge = "![deprecated](https://img.shields.io/badge/-deprecated-red)"
1818
)
1919

2020
// Replaces the Parameters placeholder with the content from the yaml
@@ -93,19 +93,19 @@ func parameterFurtherInfo(paramName string, stepData *config.StepData, execution
9393
}
9494

9595
if paramName == "script" {
96-
return checkParameterInfo(fmt.Sprintf("[!%s](#) reference to Jenkins main pipeline script", jenkinsOnlyBadge), true, executionEnvironment)
96+
return checkParameterInfo(fmt.Sprintf("%s reference to Jenkins main pipeline script", jenkinsOnlyBadge), true, executionEnvironment)
9797
}
9898

9999
// handle non-step parameters (e.g. Jenkins-specific parameters as well as execution environment parameters)
100100
jenkinsParams := []string{"containerCommand", "containerName", "containerShell", "dockerVolumeBind", "dockerWorkspace", "sidecarReadyCommand", "sidecarWorkspace", "stashContent"}
101101
if !contains(stepParameterNames, paramName) {
102102
for _, secret := range stepData.Spec.Inputs.Secrets {
103103
if paramName == secret.Name && secret.Type == "jenkins" {
104-
return checkParameterInfo(fmt.Sprintf("[!%s](#) id of credentials ([using credentials](https://www.jenkins.io/doc/book/using/using-credentials/))", jenkinsOnlyBadge), true, executionEnvironment)
104+
return checkParameterInfo(fmt.Sprintf("%s id of credentials ([using credentials](https://www.jenkins.io/doc/book/using/using-credentials/))", jenkinsOnlyBadge), true, executionEnvironment)
105105
}
106106
}
107107
if contains(jenkinsParams, paramName) {
108-
return checkParameterInfo(fmt.Sprintf("[!%s](#)", jenkinsOnlyBadge), false, executionEnvironment)
108+
return checkParameterInfo(fmt.Sprintf("%s", jenkinsOnlyBadge), false, executionEnvironment)
109109
}
110110
return checkParameterInfo("", false, executionEnvironment)
111111
}
@@ -115,17 +115,17 @@ func parameterFurtherInfo(paramName string, stepData *config.StepData, execution
115115
if paramName == param.Name {
116116
furtherInfo := ""
117117
if param.DeprecationMessage != "" {
118-
furtherInfo += fmt.Sprintf("!%s", deprecatedBadge)
118+
furtherInfo += fmt.Sprintf("%s", deprecatedBadge)
119119
}
120120
if param.Secret {
121-
secretInfo := fmt.Sprintf("[!%s](#) pass via ENV or Jenkins credentials", secretBadge)
121+
secretInfo := fmt.Sprintf("%s pass via ENV or Jenkins credentials", secretBadge)
122122

123123
isVaultSecret := param.GetReference("vaultSecret") != nil || param.GetReference("vaultSecretFile") != nil
124124
isTrustengineSecret := param.GetReference(config.RefTypeTrustengineSecret) != nil
125125
if isVaultSecret && isTrustengineSecret {
126-
secretInfo = fmt.Sprintf(" [!%s](#) [!%s](#) [!%s](/) pass via ENV, Vault, Trust Engine or Jenkins credentials", vaultBadge, trustengineBadge, secretBadge)
126+
secretInfo = fmt.Sprintf(" %s %s %s pass via ENV, Vault, Trust Engine or Jenkins credentials", vaultBadge, trustengineBadge, secretBadge)
127127
} else if isVaultSecret {
128-
secretInfo = fmt.Sprintf(" [!%s](#) [!%s](/) pass via ENV, Vault or Jenkins credentials", vaultBadge, secretBadge)
128+
secretInfo = fmt.Sprintf(" %s %s pass via ENV, Vault or Jenkins credentials", vaultBadge, secretBadge)
129129
}
130130

131131
for _, res := range param.ResourceRef {

pkg/documentation/generator/parameters_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ func TestCreateParameterOverview(t *testing.T) {
4848
expected := `| Name | Mandatory | Additional information |
4949
| ---- | --------- | ---------------------- |
5050
| [dockerImage](#dockerimage) | no | |
51-
| [stashContent](#stashcontent) | no | [![Jenkins only](https://img.shields.io/badge/-Jenkins%20only-yellowgreen)](#) |
51+
| [stashContent](#stashcontent) | no | ![Jenkins only](https://img.shields.io/badge/-Jenkins%20only-yellowgreen) |
5252
5353
`
5454
assert.Equal(t, expected, createParameterOverview(&stepData, true))
@@ -107,7 +107,7 @@ func TestParameterFurtherInfo(t *testing.T) {
107107
},
108108
},
109109
},
110-
contains: "![deprecated](https://img.shields.io/badge/-deprecated-red)[![Secret](https://img.shields.io/badge/-Secret-yellowgreen)](#)",
110+
contains: "![deprecated](https://img.shields.io/badge/-deprecated-red)![Secret](https://img.shields.io/badge/-Secret-yellowgreen)",
111111
},
112112
{
113113
paramName: "testSecret2",

0 commit comments

Comments
 (0)