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

Update Java v1.8.x support in README.md #146

Merged
merged 4 commits into from
May 19, 2020

Conversation

abhimanyusinghgaur
Copy link
Contributor

@abhimanyusinghgaur abhimanyusinghgaur commented May 18, 2020

Fixes #144.

Not adding a test because of following reasons:

  • Can't add the dependency in dgraph4j as it will enforce it for all java versions, which in not what we want.
  • Can't add it in DgraphJavaSample, as people will be looking at it irrespective of java version they use. So, I think its better for it to stay as is. Just the documentation update should be enough to guide people who face problems with Java 1.8.x

This change is Reviewable

Copy link
Contributor

@danielmai danielmai left a comment

Choose a reason for hiding this comment

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

Review the preview file and make sure the Markdown renders as expected: https://github.com/dgraph-io/dgraph4j/blob/2ef430d559cfbfecd285d8ac8bc0f65003a0b5f5/README.md

Otherwise, I have a couple of comments on phrasing and the version table.

Reviewable status: 0 of 1 files reviewed, 10 unresolved discussions (waiting on @abhimanyusinghgaur and @danielmai)


README.md, line 72 at r1 (raw file):

don't want to use

aren't using


README.md, line 72 at r1 (raw file):

above version table

"the above version table"


README.md, line 74 at r1 (raw file):

you want to use

Simplify to "you're using"


README.md, line 81 at r1 (raw file):

 ```xml

This needs a newline before these backticks to be rendered correctly in Markdown.


README.md, line 87 at r1 (raw file):

 ```xml

This needs a newline after these backticks to be rendered correctly in Markdown.


README.md, line 89 at r1 (raw file):

```groovy

This needs a newline before these backticks to be rendered correctly in Markdown.


README.md, line 91 at r1 (raw file):

This needs a newline after these backticks to be rendered correctly in Markdown.


README.md, line 92 at r1 (raw file):

Following

"The following"


README.md, line 94 at r1 (raw file):

grpc-netty

This table should also list out the corresponding netty-tcnative-boringssl-static versions too. Otherwise, it's not obvious without looking at the gRPC docs where you get 2.0.26-Final from.


README.md, line 102 at r1 (raw file):

  So, for example

Add a line between the table and this paragraph so it renders correctly in Markdown (see the rendered version here: https://github.com/dgraph-io/dgraph4j/blob/2ef430d559cfbfecd285d8ac8bc0f65003a0b5f5/README.md)

Copy link
Contributor Author

@abhimanyusinghgaur abhimanyusinghgaur left a comment

Choose a reason for hiding this comment

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

I guess, I can't trust my IDE anymore with markdown files, It was rendering it differently than what GitHub was rendering.

Reviewable status: 0 of 1 files reviewed, 10 unresolved discussions (waiting on @danielmai)


README.md, line 72 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…
don't want to use

aren't using

Done.


README.md, line 72 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…
above version table

"the above version table"

Done.


README.md, line 74 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…
you want to use

Simplify to "you're using"

Done.


README.md, line 81 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…
 ```xml

This needs a newline before these backticks to be rendered correctly in Markdown.

Done.


README.md, line 87 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…
 ```xml

This needs a newline after these backticks to be rendered correctly in Markdown.

Done.


README.md, line 89 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…
```groovy

This needs a newline before these backticks to be rendered correctly in Markdown.

Done.


README.md, line 91 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…

This needs a newline after these backticks to be rendered correctly in Markdown.

Done.


README.md, line 92 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…
Following

"The following"

Done.


README.md, line 94 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…
grpc-netty

This table should also list out the corresponding netty-tcnative-boringssl-static versions too. Otherwise, it's not obvious without looking at the gRPC docs where you get 2.0.26-Final from.

Done.


README.md, line 102 at r1 (raw file):

Previously, danielmai (Daniel Mai) wrote…
  So, for example

Add a line between the table and this paragraph so it renders correctly in Markdown (see the rendered version here: https://github.com/dgraph-io/dgraph4j/blob/2ef430d559cfbfecd285d8ac8bc0f65003a0b5f5/README.md)

Done.

Copy link
Contributor

@danielmai danielmai left a comment

Choose a reason for hiding this comment

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

:lgtm:

Ah. Yeah, Markdown is not consistent. There should be an extension to give you the same rendering that GitHub would show.

Reviewed 1 of 1 files at r2.
Reviewable status: all files reviewed, 10 unresolved discussions (waiting on @danielmai)

@abhimanyusinghgaur abhimanyusinghgaur merged commit 8589f92 into master May 19, 2020
@abhimanyusinghgaur abhimanyusinghgaur deleted the abhimanyu/gRPC-with-TLS-java8 branch May 19, 2020 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Supporting gRPC with TLS on Java 8
2 participants