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.

Sign up for GitHub

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

Jump to bottom

Clarify the supported Oracle JDK and OpenJDK versions; add a note about other JDKs and versions #1085

Merged
merged 3 commits into from
Sep 19, 2023
Merged

Clarify the supported Oracle JDK and OpenJDK versions; add a note about other JDKs and versions #1085

merged 3 commits into from
Sep 19, 2023

Conversation

josh-wong
Copy link
Member

@josh-wong josh-wong commented Sep 15, 2023 •
edited
Loading

Description

This PR clarifies the supported Oracle JDK and OpenJDK versions and adds a related note about other JDKs and versions.

Related issues and/or PRs

Related to scalar-labs/scalardb-samples#49 (comment)

Changes made

  • Revised the supported JDKs to include LTS versions 8, 11, and 17.
  • Added a note that:
    • Recommends using these LTS versions and that non-LTS versions might work.
    • Other JDKs should work, but they haven't been tested.

Branches this PR applies to

  • master
  • 3.10
  • 3.9
  • 3.8
  • 3.7
  • 3.6
  • 3.5

Testing done

I ran our docs site locally with these changes and confirmed that these revised docs, including notice blocks and formatting, appeared as expected. Attached are screenshots of the two docs as they appears on the docs site.

Note

The two screenshots below include the same contents for this section on both pages.

getting-started-with-scalardb.md

JDK prerequisites getting-started-with-scalardb

getting-started-with-scalardb-by-using-kotlin.md

JDK prerequisites for getting-started-with-scalardb-by-using-kotlin

Checklist

  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • Tests (unit, integration, etc.) have been added for the changes.
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

N/A

@josh-wong josh-wong self-assigned this Sep 15, 2023
feeblefakie
feeblefakie approved these changes Sep 19, 2023
View reviewed changes
Copy link
Contributor

@feeblefakie feeblefakie left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

choplin
choplin approved these changes Sep 19, 2023
View reviewed changes
Copy link

@choplin choplin left a comment

Choose a reason for hiding this comment

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

LGTM!

Also, I'm wondering this rule (that is, the LTS version of Oracle JDK and OpenJDK are supported) should be applied to other products. If so, this would be noted in the team-handbook as our standard policy for the products, IMO.

Torch3333
Torch3333 approved these changes Sep 19, 2023
View reviewed changes
Copy link
Contributor

@Torch3333 Torch3333 left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

komamitsu
komamitsu approved these changes Sep 19, 2023
View reviewed changes
Copy link
Contributor

@komamitsu komamitsu left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

brfrn169
brfrn169 approved these changes Sep 19, 2023
View reviewed changes
Copy link
Collaborator

@brfrn169 brfrn169 left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

@josh-wong
Copy link
Member Author

Also, I'm wondering this rule (that is, the LTS version of Oracle JDK and OpenJDK are supported) should be applied to other products. If so, this would be noted in the team-handbook as our standard policy for the products, IMO.

@choplin I agree. Maybe we can add it to the Java coding guidelines page in the team handbook?

@josh-wong josh-wong merged commit 517cad1 into master Sep 19, 2023
feeblefakie pushed a commit that referenced this pull request Sep 19, 2023
@josh-wong @brfrn169
Clarify the supported Oracle JDK and OpenJDK versions; add a note abo…
f18277e 
…ut other JDKs and versions (#1085)

Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
@feeblefakie feeblefakie mentioned this pull request Sep 19, 2023
Merged
feeblefakie pushed a commit that referenced this pull request Sep 19, 2023
@josh-wong @brfrn169
Clarify the supported Oracle JDK and OpenJDK versions; add a note abo…
6eddd44 
…ut other JDKs and versions (#1085)

Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
@feeblefakie feeblefakie mentioned this pull request Sep 19, 2023
Merged
feeblefakie pushed a commit that referenced this pull request Sep 19, 2023
@josh-wong @brfrn169
Clarify the supported Oracle JDK and OpenJDK versions; add a note abo…
64b47c7 
…ut other JDKs and versions (#1085)

Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
@feeblefakie feeblefakie mentioned this pull request Sep 19, 2023
Merged
feeblefakie pushed a commit that referenced this pull request Sep 19, 2023
@josh-wong @brfrn169
Clarify the supported Oracle JDK and OpenJDK versions; add a note abo…
03c40c9 
…ut other JDKs and versions (#1085)

Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
@feeblefakie feeblefakie mentioned this pull request Sep 19, 2023
Merged
feeblefakie pushed a commit that referenced this pull request Sep 19, 2023
@josh-wong @brfrn169
Clarify the supported Oracle JDK and OpenJDK versions; add a note abo…
e76ded3 
…ut other JDKs and versions (#1085)

Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
@feeblefakie feeblefakie mentioned this pull request Sep 19, 2023
Merged
josh-wong added a commit that referenced this pull request Sep 19, 2023
@josh-wong @brfrn169
Clarify the supported Oracle JDK and OpenJDK versions; add a note abo…
9a8f1b4 
…ut other JDKs and versions (#1085)

Co-authored-by: Toshihiro Suzuki <brfrn169@gmail.com>
@josh-wong josh-wong mentioned this pull request Sep 19, 2023
Merged
@josh-wong josh-wong deleted the docs/update-JDK-versions branch September 19, 2023 11:25
This was referenced Sep 19, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Torch3333 Torch3333 Torch3333 approved these changes

@feeblefakie feeblefakie feeblefakie approved these changes

@choplin choplin choplin approved these changes

@brfrn169 brfrn169 brfrn169 approved these changes

@komamitsu komamitsu komamitsu approved these changes

Assignees

@josh-wong josh-wong

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@josh-wong @komamitsu @brfrn169 @choplin @feeblefakie @Torch3333