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 versioning #1974

Closed
wants to merge 10 commits into from
Closed

Conversation

ion-elgreco
Copy link
Collaborator

@ion-elgreco ion-elgreco commented Dec 14, 2023

  • Adds versioning to the docs

@ion-elgreco
Copy link
Collaborator Author

I think this will break the url though.

@MrPowers
Copy link
Collaborator

@ion-elgreco - what kind of versioning? Like different docs pages for v0.14 and v0.15?

@ion-elgreco
Copy link
Collaborator Author

@MrPowers yes, different docs pages for each version, see example below:

image

@MrPowers
Copy link
Collaborator

@ion-elgreco - let's chat about this one on a call. Lots of factors to consider for this one in particular. This is an issue I have thought about extensively. Lots of pros/cons to the different approaches.

@ion-elgreco
Copy link
Collaborator Author

@MrPowers sure, maybe next week?

@r3stl355
Copy link
Contributor

r3stl355 commented Dec 14, 2023

@ion-elgreco I'm not sure if this versioning is going to work as expected because the versioning is used to build the docs but it is not aware of the deployment location so effectively will always show the same content, that dropdown will be used only as a label.

Ahh, ok, so this will be deploying into some sub-folder? This will likely be a problem for tabbed Rust/Python code snippets as they rely on a fixed URL in the docs config (pointing to API location) so you may end up with a newer version pointing to current/main docs API references (although I don't think we are using those snippets extensively atm)

@ion-elgreco
Copy link
Collaborator Author

@r3stl355 I checked, the tabbed code snippets still works. If you change the code snippet it doesn't affect the previous doc versions.

@r3stl355
Copy link
Contributor

Yes @ion-elgreco the snippets will work but the links about those code snippets will be pointing to the main docs only, this is driven by a single config value in the mkdocs.yml file (e.g. python_api_url: https://delta-io.github.io/delta-rs/api/

@ion-elgreco
Copy link
Collaborator Author

@r3stl355 Ah I see what you mean now, yeah those should be dynamic..

@ion-elgreco ion-elgreco marked this pull request as draft December 15, 2023 13:59
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.

5 participants