Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add database setup instructions to Maven plugin configuration page in the docs #2127

Closed
haslam22 opened this issue Aug 6, 2019 · 0 comments

Comments

@haslam22
Copy link

commented Aug 6, 2019

Is your feature request related to a problem? Please describe.
This page here: https://jeremylong.github.io/DependencyCheck/dependency-check-maven/configuration.html would really benefit from a link to https://jeremylong.github.io/DependencyCheck/data/database.html in the database configuration options. I can see that the Maven plugin can be configured to use a database server but I've no clue how to set up this database in the correct format. I spent a while trying to figure out how... until one of my work colleagues showed me the correct page.

You might be able to see my confusion, because the "Database server" page is buried under "Internet Access Required" and then a "Central DB" section on the documentation homepage (https://jeremylong.github.io/DependencyCheck/) which isn't immediately obvious.

Describe the solution you'd like
On the Maven plugin page in the docs, where it specifies you can use the "databaseUser", "databasePassword", "connectionString" and related database parameters, I'd like to add a reference to the "Using a Database Server" page.

Describe alternatives you've considered
Haven't thought of any yet - but suggestions welcome

Additional context
dep-check-maven-docs-screenshot-1

I am happy to create a PR for this change.

@haslam22 haslam22 added the enhancement label Aug 6, 2019
jeremylong added a commit that referenced this issue Aug 7, 2019
@jeremylong jeremylong added this to the 5.2.2 milestone Sep 22, 2019
@jeremylong jeremylong closed this Sep 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.