Improve installation documentation #531
Merged
+87
−63
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Fix wrong instructions to configure Java version - Simplify language around docker/java launcher/fat jar - Pre-install `sbt` in Docker container
Strum355
reviewed
Jan 31, 2023
docs/getting-started.md
Outdated
| > re-downloaded on every `scip-java index` invocation. | ||
| > The `sourcegraph/scip-java` Docker container is made available for convenience | ||
| > at the cost of performance. The `sourcegraph/scip-java` container is a big | ||
| > download because it includes includes pre-installed versions of Java 8, Java |
There was a problem hiding this comment.
Suggested change
| > download because it includes includes pre-installed versions of Java 8, Java | |
| > download because it includes pre-installed versions of Java 8, Java |
docs/getting-started.md
Outdated
| > download because it includes multiple pre-installed Java versions (Java 8, | ||
| > Java 11 and Java 17). Also, external dependencies of your codebase get | ||
| > re-downloaded on every `scip-java index` invocation. | ||
| > The `sourcegraph/scip-java` Docker container is made available for convenience |
There was a problem hiding this comment.
terminology nit: we supply an image, not a container
Strum355
reviewed
Feb 1, 2023
| @@ -219,8 +233,8 @@ by [Metals](https://scalameta.org/metals), the Scala language server. | |||
|
|
|||
| ### Kotlin | |||
|
|
|||
| The Kotlin support in scip-java is the least mature compared to the Java and | |||
| Scala support. Don't hesitate to report issues at | |||
| The Kotlin support in scip-java is less mature compared to the Java and Scala | |||
There was a problem hiding this comment.
Maybe worth mentioning that the K2 compiler is not supported. Im a bit fuzzy on what that means in terms of Kotlin version support (specifically around kotlin 1.8.x, Its not clear to me whether its still feature flagged)
There was a problem hiding this comment.
I'll leave this to you to update.
Strum355
approved these changes
Feb 1, 2023
|
Bazel build failure looks unrelated but still needs to be fixed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
sbtin Docker containerTest plan
n/a