Versioning Proposal #272
Versioning Proposal #272
Conversation
|
Hi @aterrel, @kamila-NF, @melissawm, I have added my proposal for the Versioning System in the DISCOVER Cookbook. Looking forward to your feedback. Best regards, |
AR21SM
changed the title
AR21SM
changed the title
|
Hi @aterrel @melissawm, I wanted to follow up on my GSoC proposal for the Versioning System for DISCOVER Cookbook that I submitted last week (21-March ). I understand you're busy with your regular work commitments, and I appreciate your time. I'm eager to receive any feedback you might have on my submission. If there are any aspects of the proposal that need improvements , I would be happy to address them. Thank you for your time and consideration. Have a nice day, |
|
Hi @AR21SM - I'm not a mentor for the GSoC program so I will defer decision to the mentors. Cheers! |
|
Hi @aterrel, I wanted to show my progress if u have 2-3 minutes can u see it :
When you have a moment, I'd appreciate your feedback on these implementations. Thanks for your time! (Just wanted to let you know that I've submitted my proposal for the DISCOVER Cookbook project on the Google Summer of Code website.) -AR21SM |
|
@AR21SM what is the name of your proposal on gsoc? |
|
nevermind. I found it. There are a lot of proposals in the system. |
aterrel
left a comment
aterrel
left a comment
There was a problem hiding this comment.
A few inline comments to be sorted.
|
Thank you for taking the time to review my proposal and provide this valuable feedback. I would like to request 3-4 days to study your suggestions thoroughly and revise my approach. I'm currently managing some college exams (quizs and lab evaluations), but I'm fully committed to addressing all your feedback points. I'll share my progress with you soon, that addresses all your comments. Thanks again for your guidance! |
|
@AR21SM have you been able to address the requested changes? |
AR21SM
force-pushed
the
Versioning_System_for_DISCOVER_Cookbook
branch
from
cac381f to
792c3b4
Compare
|
Hi @aterrel , apologies for the delay — I've now addressed all your feedback and updated the proposal, kindly requesting a re-review. |
|
|
||
| 1. **Tag-Based Version Management:**: | ||
| - Maintain a single active branch (main) | ||
| - Use Git tags to mark specific versions (latest version , previous versions) |
There was a problem hiding this comment.
we should stick to numeric versions. 1.0, 2.0, and then the latest version will just be the main branch and can be labelled 2.0-dev. One might even look at how to included versioneer so you can see which version of the book is being renderd.
| 1. **Tag-Based Version Management:**: | ||
| - Maintain a single active branch (main) | ||
| - Use Git tags to mark specific versions (latest version , previous versions) | ||
| - Deploy each tagged version to its corresponding URL path |
There was a problem hiding this comment.
Here is where you will have a development url as well. Would probably want to have a separate script for local and deployment so that folks can still iterated on the content locally without much trouble.
| - Deploy each tagged version to its corresponding URL path | ||
|
|
||
| 2. **URL Structure**: | ||
| - Latest version: discover-cookbook.numfocus.org/ |
There was a problem hiding this comment.
would be good to have a redirect for things like discover-cookbook.numfocus.org/05_venue_selection/ to ``discover-cookbook.numfocus.org/v1.0/05_venue_selection/`
| - Built-in versioning system | ||
| - Established version selector UI | ||
|
|
||
| **Disadvantages**: |
There was a problem hiding this comment.
A few others to add:
- This also requires a paid account to run ad free
- depends on a more complex service than just hosting static webpages, which can be done on a multitude of services.
3 participants
Added My proposal for Versioning System for DISCOVER Cookbook