search

scylladb / java-driver

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

docs: add default branch #314

Closed dgarcia360 closed 1 week ago

dgarcia360 commented 4 months ago

Adds default branch to the docs fix the "Edit this page" button.

Lorak-mmk commented 4 months ago

What about the driver 4.x? Will the edit button just not work for it?

Bouncheck commented 4 months ago

I'm assuming that for 4.x we need similar PR for scylla-4.x branch

Bouncheck commented 4 months ago

Maybe that's wrong assumption though. How is final documentation page created? I'm not sure who maintains it. Is it a result of make multiversion or is it a combination of a build made on 3.x branch and a separate one on 4.x branch? Because in make multiversionpreview it does indeed result in pointing to 3.x branch for 4.x versions too.

Bouncheck commented 4 months ago

It seems that on 4.x branch the docs directory is a copy of 3.x one. Looks like one made for convenience sake and that we do not maintain different configuration for 4.x. So if we create multi version (including 4.x) documentation from 3.x branch we should not be defaulting to 3.x urls for all versions. Thanks for the catch @Lorak-mmk.

dkropachev commented 3 months ago

@dgarcia360 , could you please take a look at https://github.com/scylladb/sphinx-scylladb-theme/issues/1156 before merging it.

dgarcia360 commented 1 week ago

Replaced by https://github.com/scylladb/java-driver/pull/367