-
Notifications
You must be signed in to change notification settings - Fork 38
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
Conversation
There was a problem hiding this 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.
What about the driver 4.x? Will the edit button just not work for it? |
I'm assuming that for 4.x we need similar PR for scylla-4.x branch |
Maybe that's wrong assumption though. How is final documentation page created? I'm not sure who maintains it. Is it a result of |
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. |
@dgarcia360 , could you please take a look at scylladb/sphinx-scylladb-theme#1156 before merging it. |
Replaced by #367 |
Adds default branch to the docs fix the "Edit this page" button.