Skip to content

Comments

Added dataverse.db.parameters from long list of JVM options#10670

Merged
pdurbin merged 3 commits intoIQSS:developfrom
diptechexpo:develop
Jul 8, 2024
Merged

Added dataverse.db.parameters from long list of JVM options#10670
pdurbin merged 3 commits intoIQSS:developfrom
diptechexpo:develop

Conversation

@diptechexpo
Copy link
Contributor

@diptechexpo diptechexpo commented Jul 6, 2024

Addressing documentation issue #10669. Updated the config.rst file under doc/sphinx-guides/source/installation to add missing documentation about dataverse.db.parameters under JVM Options section

What this PR does / why we need it: Improve documentation

Which issue(s) this PR closes:

Special notes for your reviewer: None

Suggestions on how to test this: No code change. Review of the documentation change is required only.

Does this PR introduce a user interface change? If mockups are available, please link/include them here: No

Is there a release notes update needed for this change?: No

Additional documentation: None

Addressing documentation issue IQSS#10669. Updated the config.rst file under doc/sphinx-guides/source/installation to add missing documentation about dataverse.db.parameters under JVM Options section
| (installer sets to ``dvndb``)
* - dataverse.db.parameters
- Connection parameters, such as ``sslmode=require``. See `Postgres JDBC docs <https://jdbc.postgresql.org/documentation/head/connect.html>`_
- Connection parameters, such as ``sslmode=require``. See `Postgres JDBC docs <https://jdbc.postgresql.org/documentation/head/connect.html>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The _ suffix may not be removed here. In RestructuredText links need this char to be declared links, otherwise the backticks are interpreted as layouting directives. See also the preview generated at https://dataverse-guide--10670.org.readthedocs.build/en/10670/installation/config.html#basic-database-settings

@poikilotherm
Copy link
Contributor

Good job overall, just a few minor tweaks. Thank you very much @diptechexpo for this PR!

As it is a docs only PR we can fast track it as usual once the review is completed and approved.

diptechexpo and others added 2 commits July 6, 2024 14:48
Co-authored-by: Oliver Bertuch <poikilotherm@users.noreply.github.com>
Added back underscore(_) character to maintain the link.
Copy link
Contributor Author

@diptechexpo diptechexpo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorporated review comments. Submitting for re-review.

Copy link
Contributor

@poikilotherm poikilotherm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Signing off, good to go!

@poikilotherm
Copy link
Contributor

@pdurbin assining to you, double checking this can be fast tracked.

Copy link
Member

@pdurbin pdurbin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://dataverse-guide--10670.org.readthedocs.build/en/10670/installation/config.html#dataverse-db-parameters looks great! Thanks for the pull request, @diptechexpo!

And thanks to @poikilotherm for noticing it was missing!

Merging!

@pdurbin pdurbin merged commit 5d32ed5 into IQSS:develop Jul 8, 2024
@pdurbin pdurbin added this to the 6.4 milestone Jul 8, 2024
@pdurbin pdurbin removed their assignment Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing dataverse.db.parameters from long list of JVM options

3 participants