search

scylladb / java-driver

ScyllaDB Java Driver for ScyllaDB and Apache Cassandra, based on the DataStax Java Driver
Apache License 2.0
62 stars 37 forks source link

Issue in page Scylla Java Driver for Scylla and Apache Cassandra® - Non-Link. Make how-to-download more prominent #78

Open PeterCorless opened 3 years ago

PeterCorless commented 3 years ago

I would like to report an issue in page https://java-driver.docs.scylladb.com/scylla-3.10.2.x/index

Problem

Useful links: SCYLLA UNIVERSITY JAVA CLASS DOCS: the manual has quick start material and technical details about the driver and its features. GITHUB REPOSITORY: https://github.com/scylladb/java-driver <— this isn't actually a working hyperlink changelog

Suggest a fix

Please provide a more prominent link to the Github repository for people interested in downloading the driver. Also make sure the URL is a working hyperlink.

PeterCorless commented 3 years ago

Also, the document states that the driver is available on Maven Central, but doesn't provide any URL to get to it or even instructions for how to search for it. I found it via searching for "ScyllaDB Java Driver" using URL:

https://search.maven.org/search?q=ScyllaDB%20Java%20driver

Is that the right way to get to it, or is there a canonical link we want people to refer to?

Edit: There's a list of items that you get as a result. Which ones does the user need? Might want to be more explicit:

Group ID | Artifact ID | Latest Version | Updated | OSS Index | Download com.scylladb | java-driver-parent | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download com.scylladb | java-driver-bom | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download com.scylladb | java-driver-metrics-microprofile | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download com.scylladb | java-driver-test-infra | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download com.scylladb | java-driver-core-shaded | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download com.scylladb | java-driver-mapper-runtime | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download com.scylladb | java-driver-mapper-processor | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download com.scylladb | java-driver-query-builder | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download com.scylladb | java-driver-core | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download com.scylladb | java-driver-metrics-micrometer | ‎ 4.9.0-scylla-1 (3) | 25-Jan-2021 | open_in_new | file_download

maeb commented 3 years ago

Thanks @PeterCorless for pointing out where to find the driver!

The documentation in https://java-driver.docs.scylladb.com/stable/#getting-the-driver say:

<dependency>
  <groupId>com.scylladb</groupId>
  <artifactId>scylla-driver-core</artifactId>
  <version>3.10.2.0</version>
</dependency>

but what works right now is:

<dependency>
  <groupId>com.scylladb</groupId>
  <artifactId>java-driver-core</artifactId>
  <version>4.9.0-scylla-1</version>
</dependency>

Similarly the artifactId is wrong in the other examples regarding driver-mapping and driver-extras.

maeb commented 3 years ago

My previous comment was not entirely correct but https://search.maven.org/search?q=g:com.scylladb tells the whole story.

The versioning for version 3 in the example seems wrong: 3.10.2.0 seems to be 3.10.2-scylla-0.

Also artifactId seems to have changed prefix from scylla- to java- between version 3 and 4.