Managing Editions of the book

[aterrel]

As discussed in other announcements, we would like to start making editions of the book. Starting this thread to discuss how to proceed.

[Iamanujosh]

I'm really excited about the possibility of contributing to the Versioning System for the book! I'd love to submit a proposal and start working on it. Could you please share any specific tools or approaches you'd recommend for managing book editions and versioning? I’m eager to get started and would appreciate any guidance!

[aterrel]

I would recommend looking at how other Jupyter Book projects do it. I started looking but haven't had time to figure it out.

[melissawm]

Hi all!

Here is a suggestion: for this handbook, I don't think we need the specific functionality of a version switcher, where specific pages can be checked in multiple versions. Rather, we can just point to a frozen version of the book the keep updating the latest version.

I've implemented that, adding links to historical versions of the cookbook in the left sidebar. This is a simple solution and feedback is appreciated.

If this sounds like a reasonable approach I can send in a PR for the source changes involved. Thanks!

https://melissawm.github.io/DISCOVER-Cookbook

[AR21SM]

hey @melissawm
Your approach to linking historical versions in the sidebar is a great step toward simplifying version management for the DISCOVER Cookbook. However, when navigating to a previous version, I noticed there’s no intuitive way to return to the latest version or switch between versions seamlessly.

A suggestion would be to implement a navigation system similar to how React handles its versioning

When visiting older versions, users are redirected to a dedicated page for that version (e.g., React's archived version pages).

Each page includes clear links or buttons to navigate back to the latest version or other historical versions.

Looking forward to your thoughts!

Best regards,
AR21SM

[AR21SM]

[AR21SM]

Hey @aterrel, @kamila-NF ,@melissawm
I've been working on the versioning system for the past week, exploring how others implement it and have recorded a demo showcasing my progress so far.

Looking forward to your feedback!
Best regards,
AR21SM

DISCOVER.Cookbook.DISCOVER.mp4