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

docs: add default branch #314

Open
wants to merge 1 commit into
base: scylla-3.x
Choose a base branch
from

Conversation

dgarcia360
Copy link

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

Bouncheck
Bouncheck previously approved these changes Jul 5, 2024
Copy link
Collaborator

@Bouncheck Bouncheck left a comment

Choose a reason for hiding this comment

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

Branch change itself LGTM, but on several pages the path does not resolve to correct files for me.
For example for load balancing manual I get https://github.com/scylladb/java-driver/edit/scylla-3.x/docs/source/manual/load_balancing/index.md
while I assume I should end up on https://github.com/scylladb/java-driver/edit/scylla-3.x/manual/load_balancing/README.md
This seems like a separate issue though so I'm approving the branch change.

@Lorak-mmk
Copy link

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

@Bouncheck
Copy link
Collaborator

Bouncheck commented Jul 5, 2024

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

@Bouncheck
Copy link
Collaborator

Bouncheck commented Jul 5, 2024

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 Bouncheck dismissed their stale review July 5, 2024 09:47

Lorak-mmk raised an important question

@Bouncheck
Copy link
Collaborator

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
Copy link
Collaborator

@dgarcia360 , could you please take a look at scylladb/sphinx-scylladb-theme#1156 before merging it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants