Skip to content
This repository has been archived by the owner on Sep 26, 2019. It is now read-only.

[PAN-2957] Add Java 11+ as a prerequisite for installing Pantheon using Homebrew. #1755

Merged
merged 6 commits into from
Jul 27, 2019

Conversation

bgravenorst
Copy link
Contributor

PR description

Add a prerequisite to the documentation informing the user that Java 11+ is required to install Pantheon using Homebrew.

* [Java JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html)

!!!attention
Pantheon requires Java 11+ to compile; earlier versions are not supported.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is misleading, it implies you need to manually install Java, but users are probably better off installing it via homebrew rather than being linked to the Oracle site.

Copy link
Contributor

Choose a reason for hiding this comment

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

The brew error message provides the easiest way to do this:

brew cask install adoptopenjdk

Not quite sure what the wording around this should be, but that's the command I'd recommend for the average user. Not sure if it's worth pointing out there are other ways to install specific versions if the user wants. https://github.com/AdoptOpenJDK/homebrew-openjdk has instructions to allow users to select from a very confusing list of possible JDKs. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Would it make more sense to remove the Oracle link, and update the admonition to, "Pantheon requires Java 11+ to compile; earlier versions are not supported. If the appropriate Java version is not installed, then Homebrew will provide you with the appropriate command to install Java. Alternatively, you can manually install the Java JDK. "?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah I think something like that, but I would include the brew cask install adoptopenjdk command to make it easy for users instead of them having to fail to install pantheon to find the command they need.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks :). I updated the description to include the install command. After much deliberation I decided not to include the link to the homebrew-openjdk page. But I'm happy to add it if you have strong feelings about it.

Copy link
Contributor

Choose a reason for hiding this comment

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

I suspect that's a good choice.

Copy link
Contributor

@ajsutton ajsutton left a comment

Choose a reason for hiding this comment

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

LGTM.

@bgravenorst bgravenorst changed the title PAN-2957: Add Java 11+ as a prerequisite for installing Pantheon using Homebrew. [PAN-2957] Add Java 11+ as a prerequisite for installing Pantheon using Homebrew. Jul 25, 2019
Copy link
Contributor

@MadelineMurray MadelineMurray left a comment

Choose a reason for hiding this comment

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

LGTM

@MadelineMurray MadelineMurray merged commit fe15b7b into PegaSysEng:master Jul 27, 2019
MadelineMurray pushed a commit to MadelineMurray/pantheon that referenced this pull request Jul 28, 2019
@bgravenorst bgravenorst deleted the PAN-2957 branch July 29, 2019 00:06
rain-on pushed a commit to rain-on/pantheon that referenced this pull request Jul 29, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants