search

payara / ecosystem-support

Placeholder repository to handle community requests for the Payara Platform ecosystem tools
3 stars 2 forks source link

Enhancement: Add gradle.home documentation to vscode-plugin #38

Closed bh-tt closed 1 year ago

bh-tt commented 2 years ago

Description

When using a local gradle installation the Run on Payara Server option fails with a Gradle home not found error if the GRADLE_HOME variable is not defined. This can be fixed by adding the gradle.home setting to your local gradle installation. However, this is not documented anywhere.

Expected Outcome

A plugin should list used properties in its README. This section is not present at this time.

Current Outcome

In order to find a fix I had to search through the source code of the plugin, finding that it does a lookup of gradle.home here.

Ecosystem Tool

VS Code

JamesHillyard commented 1 year ago

Hi @bh-tt,

Thank you for bringing this issue to our attention, after looking through our documentation and README files, I agree this is not clear, not only for our VS Code plugin, but over all our ecosystem tools. I have raised an internal issue to discuss, review and hopefully improve this issue.

I will update you once a decision on how to proceed with this has been reached, however this property will be documented in our technical documentation at the very least.

Thanks, James

JamesHillyard commented 1 year ago

Hi @bh-tt,

We decided to revamp the Ecosystem IDE documentation, where this is more clearly documented. This documentation will be published soon and we hope will clarify this for users in the future.

Thanks, James