Skip to content

Commit aa2cec0

Browse files
cx-pedro-lopescx-pedro-lopes
authored
update documentation links (#448)
1 parent 4425bfa commit aa2cec0

File tree

16 files changed

+40
-48
lines changed

16 files changed

+40
-48
lines changed

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
<p align="center">
2626
Checkmarx CLI is a standalone Checkmarx tool.
2727
<br />
28-
<a href="https://checkmarx.atlassian.net/wiki/spaces/AST/pages/2445443121/CLI+Tool"><strong>Explore the docs »</strong></a>
28+
<a href="https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html"><strong>Explore the docs »</strong></a>
2929
<br />
3030
<br />
3131
<a href="https://github.com/Checkmarx/ast-cli/issues/new/choose">Report Bug</a>
@@ -114,7 +114,7 @@ go build -o ./bin/cx-mac ./cmd
114114

115115
## Usage
116116

117-
To see how you can use our tool, please refer to the [Documentation](https://checkmarx.atlassian.net/wiki/spaces/AST/pages/2445443121/CLI+Tool)
117+
To see how you can use our tool, please refer to the [Documentation](https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html)
118118

119119

120120
## Contribution
@@ -145,7 +145,7 @@ Find more integrations from our team [here](https://github.com/Checkmarx/ci-cd-i
145145
[docker-shield]: https://img.shields.io/docker/pulls/checkmarx/ast-cli
146146
[docker-url]:https://hub.docker.com/r/checkmarx/ast-cli
147147
[documentation-shield]: https://img.shields.io/badge/docs-viewdocs-blue.svg
148-
[documentation-url]:https://checkmarx.atlassian.net/wiki/spaces/AST/pages/2967766116/CxAST+Plugins
148+
[documentation-url]:https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html
149149
[contributors-shield]: https://img.shields.io/github/contributors/Checkmarx/ast-cli.svg
150150
[contributors-url]: https://github.com/Checkmarx/ast-cli/graphs/contributors
151151
[forks-shield]: https://img.shields.io/github/forks/Checkmarx/ast-cli.svg

‎internal/commands/auth.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func NewAuthCommand(authWrapper wrappers.AuthWrapper) *cobra.Command {
5959
),
6060
"command:doc": heredoc.Doc(
6161
`
62-
https://checkmarx.atlassian.net/wiki/x/LwF4tQ
62+
https://checkmarx.com/resource/documents/en/34965-68627-auth.html
6363
`,
6464
),
6565
},
@@ -72,7 +72,7 @@ func NewAuthCommand(authWrapper wrappers.AuthWrapper) *cobra.Command {
7272
Annotations: map[string]string{
7373
"command:doc": heredoc.Doc(
7474
`
75-
https://checkmarx.atlassian.net/wiki/x/LwF4tQ
75+
https://checkmarx.com/resource/documents/en/34965-68627-auth.html#UUID-c64cdceb-1072-ca20-aa7d-2ba9fd0c4160
7676
`,
7777
),
7878
},
@@ -105,7 +105,7 @@ func NewAuthCommand(authWrapper wrappers.AuthWrapper) *cobra.Command {
105105
Annotations: map[string]string{
106106
"command:doc": heredoc.Doc(
107107
`
108-
https://checkmarx.atlassian.net/wiki/x/LwF4tQ
108+
https://checkmarx.com/resource/documents/en/34965-68627-auth.html#UUID-01803060-8f64-8090-c956-2b505b1d4b61
109109
`,
110110
),
111111
},

‎internal/commands/project.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ func NewProjectCommand(projectsWrapper wrappers.ProjectsWrapper, groupsWrapper w
6767
Annotations: map[string]string{
6868
"command:doc": heredoc.Doc(
6969
`
70-
https://checkmarx.atlassian.net/wiki/x/BQDMkQ
70+
https://checkmarx.com/resource/documents/en/34965-68634-project.html
7171
`,
7272
),
7373
},
@@ -85,7 +85,7 @@ func NewProjectCommand(projectsWrapper wrappers.ProjectsWrapper, groupsWrapper w
8585
Annotations: map[string]string{
8686
"command:doc": heredoc.Doc(
8787
`
88-
https://checkmarx.atlassian.net/wiki/x/hIYhuw
88+
https://checkmarx.com/resource/documents/en/34965-68634-project.html#UUID-44ecd672-8f1f-32de-6c2e-838b680a0bf4
8989
`,
9090
),
9191
},
@@ -109,7 +109,7 @@ func NewProjectCommand(projectsWrapper wrappers.ProjectsWrapper, groupsWrapper w
109109
Annotations: map[string]string{
110110
"command:doc": heredoc.Doc(
111111
`
112-
https://checkmarx.atlassian.net/wiki/x/Tochuw
112+
https://checkmarx.com/resource/documents/en/34965-68634-project.html#UUID-bd2c6c68-081a-e134-b16b-067aba3a8eae
113113
`,
114114
),
115115
},
@@ -128,7 +128,7 @@ func NewProjectCommand(projectsWrapper wrappers.ProjectsWrapper, groupsWrapper w
128128
Annotations: map[string]string{
129129
"command:doc": heredoc.Doc(
130130
`
131-
https://checkmarx.atlassian.net/wiki/x/agghuw
131+
https://checkmarx.com/resource/documents/en/34965-68634-project.html#UUID-a5d021d1-2917-4327-a889-b4f1a9d19b6d
132132
`,
133133
),
134134
},
@@ -147,7 +147,7 @@ func NewProjectCommand(projectsWrapper wrappers.ProjectsWrapper, groupsWrapper w
147147
Annotations: map[string]string{
148148
"command:doc": heredoc.Doc(
149149
`
150-
https://checkmarx.atlassian.net/wiki/x/agghuw
150+
https://checkmarx.com/resource/documents/en/34965-68634-project.html
151151
`,
152152
),
153153
},
@@ -167,7 +167,7 @@ func NewProjectCommand(projectsWrapper wrappers.ProjectsWrapper, groupsWrapper w
167167
Annotations: map[string]string{
168168
"command:doc": heredoc.Doc(
169169
`
170-
https://checkmarx.atlassian.net/wiki/x/UAchuw
170+
https://checkmarx.com/resource/documents/en/34965-68634-project.html#UUID-2382b35f-fac9-f169-711b-73570278adb1
171171
`,
172172
),
173173
},
@@ -186,7 +186,7 @@ func NewProjectCommand(projectsWrapper wrappers.ProjectsWrapper, groupsWrapper w
186186
Annotations: map[string]string{
187187
"command:doc": heredoc.Doc(
188188
`
189-
https://checkmarx.atlassian.net/wiki/x/FIghuw
189+
https://checkmarx.com/resource/documents/en/34965-68634-project.html#UUID-eab37623-899c-e97d-e702-6b1946592986
190190
`,
191191
),
192192
},

‎internal/commands/result.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ func NewResultsCommand(
8888
Annotations: map[string]string{
8989
"command:doc": heredoc.Doc(
9090
`
91-
https://checkmarx.atlassian.net/l/c/6NqgVMPM
91+
https://checkmarx.com/resource/documents/en/34965-68640-results.html
9292
`,
9393
),
9494
},

‎internal/commands/root.go

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,9 @@ func NewAstCLI(
5252
`,
5353
),
5454
Annotations: map[string]string{
55-
"utils:env": heredoc.Doc(
56-
`
57-
See 'cx utils env' for the list of supported environment variables.
58-
`,
59-
),
6055
"command:doc": heredoc.Doc(
6156
`
62-
https://checkmarx.atlassian.net/wiki/x/MYDCkQ
57+
https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html
6358
`,
6459
),
6560
},

‎internal/commands/scan.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ func NewScanCommand(
113113
Annotations: map[string]string{
114114
"command:doc": heredoc.Doc(
115115
`
116-
https://checkmarx.atlassian.net/wiki/x/9YuXtw
116+
https://checkmarx.com/resource/documents/en/34965-68643-scan.html
117117
`,
118118
),
119119
},
@@ -173,7 +173,7 @@ func scanRealtimeSubCommand() *cobra.Command {
173173
Annotations: map[string]string{
174174
"command:doc": heredoc.Doc(
175175
`
176-
https://checkmarx.atlassian.net/l/c/GddHidUN
176+
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-350af120-85fa-9f20-7051-6d605524b4fc
177177
`,
178178
),
179179
},
@@ -232,7 +232,7 @@ func scanTagsSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
232232
Annotations: map[string]string{
233233
"command:doc": heredoc.Doc(
234234
`
235-
https://checkmarx.atlassian.net/wiki/x/546Xtw
235+
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-d1d53a56-197a-6a16-95e5-c437e6dc060a
236236
`,
237237
),
238238
},
@@ -254,7 +254,7 @@ func scanCancelSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
254254
Annotations: map[string]string{
255255
"command:doc": heredoc.Doc(
256256
`
257-
https://checkmarx.atlassian.net/wiki/x/aY2Xtw
257+
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-800f2022-3609-3f40-6f77-9371e54f8b71
258258
`,
259259
),
260260
},
@@ -276,7 +276,7 @@ func scanDeleteSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
276276
Annotations: map[string]string{
277277
"command:doc": heredoc.Doc(
278278
`
279-
https://checkmarx.atlassian.net/wiki/x/-AuYtw
279+
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-851aa940-0454-ec17-4d29-42a2fa1352e0
280280
`,
281281
),
282282
},
@@ -299,7 +299,7 @@ func scanWorkflowSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
299299
Annotations: map[string]string{
300300
"command:doc": heredoc.Doc(
301301
`
302-
https://checkmarx.atlassian.net/wiki/x/Ug2Ytw
302+
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-9a524fb7-0dba-314d-9068-ccea184bc8d9
303303
`,
304304
),
305305
},
@@ -322,7 +322,7 @@ func scanShowSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
322322
Annotations: map[string]string{
323323
"command:doc": heredoc.Doc(
324324
`
325-
https://checkmarx.atlassian.net/wiki/x/qAyYtw
325+
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-c073d85b-7605-0c89-909c-7d5b9caaec16
326326
`,
327327
),
328328
},
@@ -345,7 +345,7 @@ func scanListSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
345345
Annotations: map[string]string{
346346
"command:doc": heredoc.Doc(
347347
`
348-
https://checkmarx.atlassian.net/wiki/x/K46Xtw
348+
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-f92335a6-5b1c-e158-7914-2a4e72a2ada5
349349
`,
350350
),
351351
},
@@ -374,7 +374,7 @@ func scanCreateSubCommand(
374374
Annotations: map[string]string{
375375
"command:doc": heredoc.Doc(
376376
`
377-
https://checkmarx.atlassian.net/wiki/x/WguYtw
377+
https://checkmarx.com/resource/documents/en/34965-68643-scan.html#UUID-a0bb20d5-5182-3fb4-3da0-0e263344ffe7
378378
`,
379379
),
380380
},

‎internal/commands/util/completion.go

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,8 @@ func NewCompletionCommand() *cobra.Command {
7171
ValidArgs: []string{"bash", "zsh", "fish", "powershell"},
7272
RunE: runCompletionCmd(),
7373
Annotations: map[string]string{
74-
"utils:env": heredoc.Doc(`
75-
See 'cx utils env' for the list of supported environment variables
76-
`),
7774
"command:doc": heredoc.Doc(`
78-
https://checkmarx.atlassian.net/wiki/x/iw0huw
75+
https://checkmarx.com/resource/documents/en/34965-68653-utils.html#UUID-e086afe1-7bd7-917c-8440-0e965f2e348e
7976
`),
8077
},
8178
}

‎internal/commands/util/configuration.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func NewConfigCommand() *cobra.Command {
5656
),
5757
"command:doc": heredoc.Doc(
5858
`
59-
https://checkmarx.atlassian.net/wiki/x/gwQRtw
59+
https://checkmarx.com/resource/documents/en/34965-68630-configure.html
6060
`,
6161
),
6262
},
@@ -83,7 +83,7 @@ func NewConfigCommand() *cobra.Command {
8383
Annotations: map[string]string{
8484
"command:doc": heredoc.Doc(
8585
`
86-
https://checkmarx.atlassian.net/wiki/x/gwQRtw
86+
https://checkmarx.com/resource/documents/en/34965-68621-checkmarx-one-cli-quick-start-guide.html
8787
`,
8888
),
8989
},
@@ -102,7 +102,7 @@ func NewConfigCommand() *cobra.Command {
102102
Annotations: map[string]string{
103103
"command:doc": heredoc.Doc(
104104
`
105-
https://checkmarx.atlassian.net/wiki/x/gwQRtw
105+
https://checkmarx.com/resource/documents/en/34965-68630-configure.html#UUID-44d2b9af-ae5d-3be9-5e3e-0fda0ab85e05
106106
`,
107107
),
108108
},

‎internal/commands/util/env.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ func NewEnvCheckCommand() *cobra.Command {
2222
Annotations: map[string]string{
2323
"command:doc": heredoc.Doc(
2424
`
25-
https://checkmarx.atlassian.net/wiki/x/VJGXtw
25+
https://checkmarx.com/resource/documents/en/34965-68653-utils.html#UUID-f7245425-72b9-9854-a60a-a9f37e0173d9
2626
`,
2727
),
2828
},

‎internal/commands/util/help.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,15 @@ func RootHelpFunc(command *cobra.Command) {
5858
}
5959

6060
helpEntries = append(helpEntries, helpEntry{"QUICK START GUIDE",
61-
"https://checkmarx.atlassian.net/wiki/x/mIKctw"})
61+
"https://checkmarx.com/resource/documents/en/34965-68621-checkmarx-one-cli-quick-start-guide.html"})
6262

6363
if _, ok := command.Annotations["utils:env"]; ok {
6464
helpEntries = append(helpEntries, helpEntry{"ENVIRONMENT VARIABLES", command.Annotations["utils:env"]})
6565
}
6666

6767
helpEntries = append(helpEntries, helpEntry{"LEARN MORE",
6868
heredoc.Doc(`Use 'cx <command> <subcommand> --help' for more information about a command.
69-
Read the manual at https://checkmarx.atlassian.net/wiki/x/MYDCkQ`)})
69+
Read the manual at https://checkmarx.com/resource/documents/en/34965-68620-checkmarx-one-cli-tool.html`)})
7070

7171
out := command.OutOrStdout()
7272
for _, e := range helpEntries {

0 commit comments

Comments
 (0)