Skip to content

Commit

Permalink
Replace all portal URLs that points to documentation (#243)
Browse files Browse the repository at this point in the history
  • Loading branch information
zozs authored Jun 19, 2024
1 parent c4a35f3 commit 8bba216
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion README.FoD.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ It is therefore important that the package managers are installed, with the righ
When the resolution is complete, you will see the list of files that were resolved. If the resolution were to fail, descriptive error messages from the respective package manager
will be shown in the output.

For more information on how resolution works, check out https://portal.debricked.com/debricked-cli-63/high-performance-scan-faster-more-accurate-and-more-secure-dependency-scanning-293.
For more information on how resolution works, check out https://docs.debricked.com/tools-and-integrations/cli/debricked-cli/high-performance-scans.

#### Private Registries
If a dependency is hosted on a private registry some configuration may be needed, depending on package manager. For more details see package manager specific resolution README files in the specific [package manager folder](https://github.com/debricked/cli/tree/main/internal/resolution/pm) or search the documentation of your package manager of choice.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ docker pull debricked/cli:1-resolution-debian
## Scan
Once you've installed the CLI, you're ready to scan your project. You can scan a local project, or integrate a scanning mechanism in your CI/CD pipeline.
1. [Sign up to Debricked](https://debricked.com/app/en/register)
2. [Create an access token](https://portal.debricked.com/administration-47/how-do-i-generate-an-access-token-130)
2. [Create an access token](https://docs.debricked.com/product/administration/generate-access-token)
3. `debricked scan -t <access-token>`

When the scan is complete, you will see the total number of vulnerabilities found and a list of automation rules that have been evaluated. Read more about automations [here](https://debricked.com/docs/automation/automation-overview.html#automation-overview).
Expand Down
6 changes: 3 additions & 3 deletions internal/client/request.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,13 @@ func interpret(res *http.Response, request func() (*http.Response, error), debCl
return nil, NoResErr
} else if res.StatusCode == http.StatusForbidden {
errMsg := `Forbidden. You don't have the necessary access to perform this action.
Make sure your access token has proper access https://portal.debricked.com/administration-47/how-do-i-generate-an-access-token-130
For enterprise users: Contact your Debricked company admin or repository admin to request proper access https://portal.debricked.com/administration-47/how-do-i-use-role-based-access-control-324`
Make sure your access token has proper access https://docs.debricked.com/product/administration/generate-access-token
For enterprise users: Contact your Debricked company admin or repository admin to request proper access https://docs.debricked.com/product/administration/users/role-based-access-control-enterprise`

return nil, errors.New(errMsg)
} else if res.StatusCode == http.StatusUnauthorized {
errMsg := `Unauthorized. Specify access token.
Read more on https://portal.debricked.com/administration-47/how-do-i-generate-an-access-token-130`
Read more on https://docs.debricked.com/product/administration/generate-access-token`
if retry {
err := debClient.authenticate()
if err != nil {
Expand Down
6 changes: 3 additions & 3 deletions internal/cmd/callgraph/callgraph.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ func NewCallgraphCmd(generator cg.IGenerator) *cobra.Command {
Build: Build the project and resolve dependencies. In this step, all necessary .class files are created.
Callgraph: Generate the static call graph using debricked Reachability Analysis.
The full documentation is available here https://portal.debricked.com/debricked-cli-63/debricked-cli-documentation-298
The full documentation is available here https://docs.debricked.com/tools-and-integrations/cli/debricked-cli
Example:
$ debricked callgraph
Expand Down Expand Up @@ -78,8 +78,8 @@ $ debricked callgraph . `+exampleFlags)
Examples:
$ debricked scan . --include '**/node_modules/**'`)
cmd.Flags().BoolVar(&buildDisabled, NoBuildFlag, false, `Do not automatically build all source code in the project to enable call graph generation.
This option requires a pre-built project. For more detailed documentation on the callgraph generation, visit our portal:
https://portal.debricked.com/debricked-cli-63/debricked-cli-documentation-298?tid=298&fid=63#callgraph`)
This option requires a pre-built project. For more detailed documentation on the callgraph generation, visit:
https://docs.debricked.com/tools-and-integrations/cli/debricked-cli#callgraph`)
cmd.Flags().IntVar(&generateTimeout, GenerateTimeoutFlag, 60*60, "Timeout (in seconds) on call graph generation.")
cmd.Flags().StringVarP(&languages, LanguagesFlag, "l", strings.Join(supportedLanguages, ","), "Colon separated list of languages to create a call graph for.")

Expand Down
4 changes: 2 additions & 2 deletions internal/cmd/root/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ func NewRootCmd(version string, container *wire.CliContainer) *cobra.Command {
Use: "debricked",
Short: "Debricked CLI - Keep track of your dependencies!",
Long: `A fast and flexible software composition analysis CLI tool, given to you by Debricked.
Complete documentation is available at https://portal.debricked.com/debricked-cli-63/debricked-cli-documentation-298`,
Complete documentation is available at https://docs.debricked.com/tools-and-integrations/cli/debricked-cli`,
PreRun: func(cmd *cobra.Command, _ []string) {
_ = viper.BindPFlags(cmd.PersistentFlags())
},
Expand All @@ -35,7 +35,7 @@ Complete documentation is available at https://portal.debricked.com/debricked-cl
"t",
"",
`Debricked access token.
Read more: https://portal.debricked.com/administration-47/how-do-i-generate-an-access-token-130`,
Read more: https://docs.debricked.com/product/administration/generate-access-token`,
)

var debClient = container.DebClient()
Expand Down

0 comments on commit 8bba216

Please sign in to comment.