Skip to content

Commit ffd8911

Browse files
committed
Address feedback
1 parent 34679e0 commit ffd8911

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

docs/getting-started.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,16 @@ tools that we're planning to support in the future.
1414
The most common way to use `scip-java` is to run it from CI to upload SCIP
1515
indexes after merging a pull request.
1616

17-
The easiest way to install `scip-java` is to use the Docker launcher.
17+
The easiest way to install `scip-java` is to use the Docker image.
1818

19-
### Docker container
19+
<!-- The #docker-container span below is included for backwards compatibility
20+
after we renamed the "Docker container" section into "Docker image". -->
2021

21-
Use the `sourcegraph/scip-java` Docker container to run `scip-java`.
22+
<span id="docker-container"></span>
23+
24+
### Docker image
25+
26+
Use the `sourcegraph/scip-java` Docker image to run `scip-java`.
2227

2328
```sh
2429
$ docker run -v $(pwd):/home/gradle --env JVM_VERSION=8 sourcegraph/scip-java:latest scip-java index
@@ -28,18 +33,17 @@ $ src code-intel upload # (optional) upload index to Sourcegraph
2833
If everything went OK, a `index.scip` file should exist after the command has
2934
finished indexing the project.
3035

31-
> The `sourcegraph/scip-java` Docker container is made available for convenience
32-
> at the cost of performance. The `sourcegraph/scip-java` container is a big
33-
> download because it includes includes pre-installed versions of Java 8, Java
34-
> 11, and Java 17. The `sourcegraph/scip-java` container has slow performance
35-
> because it needs to download all external dependencies of your codebase on
36-
> every invocation.
36+
> The `sourcegraph/scip-java` Docker image is made available for convenience at
37+
> the cost of performance. The `sourcegraph/scip-java` image is a big download
38+
> because it includes pre-installed versions of Java 8, Java 11, and Java 17.
39+
> The `sourcegraph/scip-java` image has slow performance because it needs to
40+
> download all external dependencies of your codebase on every invocation.
3741
>
38-
> For better performance, we recommend using your own Docker container together
39-
> with the [Java launcher](#java-launcher) option.
42+
> For better performance, we recommend using your own Docker image together with
43+
> the [Java launcher](#java-launcher) option.
4044
41-
Java 8 is the default Java version in the `sourcegraph/scip-java` Docker
42-
container. Use the following commands to use a different JVM version:
45+
Java 8 is the default Java version in the `sourcegraph/scip-java` Docker image.
46+
Use the following commands to use a different JVM version:
4347

4448
```sh
4549
# Java 11
@@ -52,7 +56,7 @@ docker run -v $(pwd):/home/gradle --env JVM_VERSION=17 sourcegraph/scip-java:lat
5256
### Java launcher
5357

5458
Use the Java launcher to install `scip-java` on your local computer or any
55-
Docker container with a pre-installed Java version.
59+
Docker image with a pre-installed Java version.
5660

5761
```sh
5862
# macOS/Linux

0 commit comments

Comments
 (0)